If the ID does not use the default base URI (namespace), then the local baseURI goes here. Note that all IDs must be unique within a form, even if they do not have the same baseURI. Ideally, the baseURI + ID should combine to form a *globally* unique identifier, that uniquely identifies an item in a particular form. The same baseURI and ID may be reused in derived or versioned forms, as long as the context stays the same, and any affected data elements remain unchanged in context and semantics. Following this approach is likely to simplify analytics based on form content.
NEW: URI used to identify the form that that this FormDesign is based upon. In most cases, this should be a standard form that is modified and/or extended by the current FormDesign. The current template reuses the basedOn IDs whenever the question/answer/semantic context is identical to the original.5/11/17: Relying on data element mapping may be a better and more flexible approach than @basedOnURI. In this way, forms could compare data elements to determine if they contain semantic matches, and this is supported better with a more robust code map section.
NEW: filename to use when the current FormDesign instance is saved as a file. For forms containing responses, the filename may include the formInstanceVersionURI, but the naming convention may be use-case-specific.
NEW: Unique URI used to identify a unique instance of a form. Used for tracking form responses across time and across multiple episodes of editing by end-users. This URI does not change for each edit session of a form instance.
NEW: Unique URI used to identify a unique instance of a form's saved responses. It is used for tracking form responses across time and across multiple episodes of editing by end-users. This URI must change for each edit/save session of a form instance. It may be e.g., a new GUID, or a repeat of the formInstanceID followed by a version number.
NEW: Unique URI used to identify the immediate previous instance of a form containing responses. This is the @formInstanceVersionURI that represents the instance of the form that the user opened up before beginning a new cycle of edit/save. This attribute is used for tracking form responses across time and across multiple episodes of editing by end-users. This URI must change for each edit session of a form instance.
NEW: The full URI that uniquely identifies the current form. It is created by concatenating @baseURI + lineage + version. Each of the componenets is separated by a single forward slash.
NEW: A text identifier that is used to group multiple versions of a single form. The lineage is constant for all versions of a single kind of form. When appended to @baseURI, it can be used to retrieve all versions of one particular form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
Allows the form filler to specify whether the current response is the initial response, or records the type of change made since the initial response was reported.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
NEW: @version contains the version text for the current form. It is designed to be used in conjuction with @baseURI and @lineage.
Source
<xs:element name="FormDesign" type="FormDesignType"><xs:annotation><xs:documentation>Root element of this Schema</xs:documentation></xs:annotation></xs:element>
NEW:This event is fired before the page is loaded into memory, and before stored form data is loaded. It may be used, e.g., for authentication, to retrieve/prepare stored data, and/or to control form rendering according to user preferences.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Optional message that appears when the rule evaluates to true
Source
<xs:element minOccurs="0" name="BeforeLoadForm" type="EventType"><xs:annotation><xs:documentation>NEW: This event is fired before the page is loaded into memory, and before stored form data is loaded. It may be used, e.g., for authentication, to retrieve/prepare stored data, and/or to control form rendering according to user preferences.</xs:documentation></xs:annotation></xs:element>
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Applies only to items that have Response Fields (Questions and ListItems). If the ListItem or Question has a Response Field, and that field has a value in it, this property returns true. If it does not have a value, it returns false. If no Response Field is present, it retuns null and is not used for Boolean comparisons.
Applies only to Questions that have selection lists (ListItems or LookupField). Evaluates to true if the number of selected items equals the entered value.
Applies only to Questions that have selection lists (ListItems or LookupField). Evaluates to true if the number of selected items equals or exceeds the entered value.
Applies only to Questions that have selection lists (ListItems or LookupField). Evaluates to true if the number of selected items is less than or equal to the entered value.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Applies only to items that have Response Fields (Questions and ListItems). If the ListItem or Question has a Response Field, and that field has a value in it, this property returns true. If it does not have a value, it returns false. If no Response Field is present, it retuns null and is not used for Boolean comparisons.
Applies only to Questions that have selection lists (ListItems or LookupField). Evaluates to true if the number of selected items equals the entered value.
Applies only to Questions that have selection lists (ListItems or LookupField). Evaluates to true if the number of selected items equals or exceeds the entered value.
Applies only to Questions that have selection lists (ListItems or LookupField). Evaluates to true if the number of selected items is less than or equal to the entered value.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:element name="Action" type="ActActionType"><xs:annotation><xs:documentation>A generic ExtensionBaseType for custom actions in a "Then" section.</xs:documentation></xs:annotation></xs:element>
Defines the data type held by a string value.Also defines the dataType for list items in a list, which uses the generic string type, since string can represent any XML data type. List items of any data type should be validated by the implementation software, since all data types are written into an XML list of type string.For typed items included by reference to an external (reference or variable) value, use short name strings preceded by "$".
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
If the ID does not use the default base URI (namespace), then the local baseURI goes here. Note that all IDs must be unique within a form, even if they do not have the same baseURI. Ideally, the baseURI + ID should combine to form a *globally* unique identifier, that uniquely identifies an item in a particular form. The same baseURI and ID may be reused in derived or versioned forms, as long as the context stays the same, and any affected data elements remain unchanged in context and semantics. Following this approach is likely to simplify analytics based on form content.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
DRAFT: The baseURI of the package, whihc indicates the home source of the package. The formManagerURP + pkgBaseURI + pkgID are concatenated to retrieve an empty form. formManagerURP + pkgBaseURI + pkgInstanceVersionURI are concatenated to retrieve a specific version of a populated form. formManagerURP + pkgBaseURI + pkgInstanceURI are concatenated to retrieve the latest instance of a populated form.
NEW: Unique URI used to identify a unique instance of a package. Used for tracking form responses across time and across multiple episodes of editing by end-users. This URI does not change for each edit session of a package instance.
NEW: Unique URI used to identify a unique instance of a package's saved responses. It is used for tracking package responses across time and across multiple episodes of editing by end-users. This URI must change for each edit/save session of a package instance. It may be e.g., a new GUID, or a repeat of the pkgInstanceID followed by a version number.
The rootItemID is the ID of the form part that will be injected. If empty, then the entre form should be injected as the FormDesign element node. If not empty, it must point to a valid Section or Question.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
If the ID does not use the default base URI (namespace), then the local baseURI goes here. Note that all IDs must be unique within a form, even if they do not have the same baseURI. Ideally, the baseURI + ID should combine to form a *globally* unique identifier, that uniquely identifies an item in a particular form. The same baseURI and ID may be reused in derived or versioned forms, as long as the context stays the same, and any affected data elements remain unchanged in context and semantics. Following this approach is likely to simplify analytics based on form content.
A globally unique string assigned to a repeating Question or Section, Injected Form, or any selected answer ListItem. This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among sections or questions, including those that are allowed to repeat and nest deeply.
@maxCard is the maximum number of repetitions allowed for a section or question. The default value is 1, indicating that the section or question cannot be repeated on the data entry form. A value of 0 indicates that the number of repeats is unlimited. If @maxCard is not 0, then Must be greater than or equal to minCard.
@minCard is the minimum number of repetitions allowed for a section or question. The default value is 1, indicating that the user must answer any question(s) that has this attribute set. If @minCard is set to 0, then the item and all descendent questions are optional to answer.
If this attribute is set to "true" (the default), then the form implementation must make this item available for use on the form. If this attribute is set to "false" on a parent or ancestor item, then all child/descendant items inherit this "false" setting, even if they have this attribute set to "true." In other words, the child/descendent items do not need to be implemented if any parent/ancestor item has this attribute set to false.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
A globally unique string assigned from a Section, Question, ListItem or InjectedForm to the ID of its parent node (S, Q, LI or IF). This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among the above objects, including those that are allowed to repeat and nest deeply.
Allows the form filler to specify whether the current response is the initial response, or records the type of change made since the initial response was reported.
CHANGED to T/F/OptionalIf @showInReport on a Question is false, then the Question and its ListItems (if any) should not be present in a typical report derived from this template. If this attribute appears on a ListItem, then the entire question and all ListItems should be omitted from the report. If this attribute appears on a Section, then the entire Section and all Section contents (descendents) should be omitted from the report. If @showInReport appears on a DisplayedItem, then the DisplayedItem (and all sub-items) should be omitted from the report.This attribute is usually set to false when a Question is used to control form behavior (e.g., skip logic), or when the Question provides unhelpful "negative" information about actions that did not occur or were not performed, or things that were not observed.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:element maxOccurs="unbounded" minOccurs="0" name="Link" type="LinkType"><xs:annotation><xs:documentation>Link to external information.</xs:documentation></xs:annotation></xs:element>
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:element name="BlobContent" type="BlobType" minOccurs="0" maxOccurs="unbounded"><xs:annotation><xs:documentation>Blob information associated with the current DisplayedType. The blob may contain any type of special media, but must be base 64 encoded.</xs:documentation></xs:annotation></xs:element>
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:element maxOccurs="unbounded" name="Contact" type="ContactType" minOccurs="0"><xs:annotation><xs:documentation>Any desired contact information regarding, e.g., the form item, authoring process, certifications, code or coding processs.</xs:documentation></xs:annotation></xs:element>
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:element maxOccurs="unbounded" minOccurs="0" name="CodedValue" type="CodingType"><xs:annotation><xs:documentation>Coding, terminology, classification, keyword, or local values</xs:documentation></xs:annotation></xs:element>
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Defines the data type held by a string value.Also defines the dataType for list items in a list, which uses the generic string type, since string can represent any XML data type. List items of any data type should be validated by the implementation software, since all data types are written into an XML list of type string.For typed items included by reference to an external (reference or variable) value, use short name strings preceded by "$".
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Defines the data type held by a string value.Also defines the dataType for list items in a list, which uses the generic string type, since string can represent any XML data type. List items of any data type should be validated by the implementation software, since all data types are written into an XML list of type string.For typed items included by reference to an external (reference or variable) value, use short name strings preceded by "$".
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Defines the data type held by a string value.Also defines the dataType for list items in a list, which uses the generic string type, since string can represent any XML data type. List items of any data type should be validated by the implementation software, since all data types are written into an XML list of type string.For typed items included by reference to an external (reference or variable) value, use short name strings preceded by "$".
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Defines the data type held by a string value.Also defines the dataType for list items in a list, which uses the generic string type, since string can represent any XML data type. List items of any data type should be validated by the implementation software, since all data types are written into an XML list of type string.For typed items included by reference to an external (reference or variable) value, use short name strings preceded by "$".
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Defines the data type held by a string value.Also defines the dataType for list items in a list, which uses the generic string type, since string can represent any XML data type. List items of any data type should be validated by the implementation software, since all data types are written into an XML list of type string.For typed items included by reference to an external (reference or variable) value, use short name strings preceded by "$".
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Defines the data type held by a string value.Also defines the dataType for list items in a list, which uses the generic string type, since string can represent any XML data type. List items of any data type should be validated by the implementation software, since all data types are written into an XML list of type string.For typed items included by reference to an external (reference or variable) value, use short name strings preceded by "$".
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Defines the data type held by a string value.Also defines the dataType for list items in a list, which uses the generic string type, since string can represent any XML data type. List items of any data type should be validated by the implementation software, since all data types are written into an XML list of type string.For typed items included by reference to an external (reference or variable) value, use short name strings preceded by "$".
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:element name="CallCode" type="CallFuncType"><xs:annotation><xs:documentation>Execute a local rule located elsewhere in the FormDesign template. Use the @name value in @val property of Function</xs:documentation></xs:annotation></xs:element>
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Optional message that appears when the rule evaluates to true
Source
<xs:element minOccurs="0" name="ActivateIf" type="GuardType"><xs:annotation><xs:documentation>Activate the DisplayedType item if the guard conditions are met.</xs:documentation></xs:annotation></xs:element>
Applies only to items that have Response Fields (Questions and ListItems). If the ListItem or Question has a Response Field, and that field has a value in it, this property returns true. If it does not have a value, it returns false. If no Response Field is present, it retuns null and is not used for Boolean comparisons.
Applies only to Questions that have selection lists (ListItems or LookupField). Evaluates to true if the number of selected items equals the entered value.
Applies only to Questions that have selection lists (ListItems or LookupField). Evaluates to true if the number of selected items equals or exceeds the entered value.
Applies only to Questions that have selection lists (ListItems or LookupField). Evaluates to true if the number of selected items is less than or equal to the entered value.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
This list contains names of ListItems (answer choices) that are watched for being selected or unselected.If a ListItem appears in this list, then it evaluates to true when it is selected. If a ListItem is prefixed with a hyphen (-), then it evaluates to true when unselected. These Boolean values, derived from each named ListItem in the list, are ANDed together (by default) to produce a return value of true or false. The default Boolean operator (AND) may be changed using @boolOp. If @not = true, then the Boolean result is logically negated.Renamed from: ListItemSelections
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The ListItem that is being evaluated for the presence of disallowed selections (in @listItemNames). This attributes contains the @name of one ListItem.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
List of names of Sections, Questions, ListItems and/or InjectedItems. Each of the named items will evaluate to true or false, based on the following validation rules:If the name points to a Section, then the Section evaluates to true (valid) if all of its descendant items are answered correctly, according to their metadata.If the name points to a Question then the Question evaluates to true (valid) if it is correctly answered according to its metadata, and also, all descendant items are answered correctly, according to their metadata.If the name points to a ListItem then the ListItem evaluates to true (valid) if it is selected, and also, all descendant items are answered correctly according to their metadata.If the name points to an InjectedItem then the InjectedItem evaluates to true (valid) if all descendant items are answered correctly, according to their metadata.The number of true responses are added together. If they satisfy the minAnswered and maxAnswered attribute values, then this type returns true. Otherwise it returns false.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Optional message that appears when the rule evaluates to true
Source
<xs:element minOccurs="0" name="DeActivateIf" type="GuardType"><xs:annotation><xs:documentation>DeActivate the DisplayedType item if the guard conditions are met.</xs:documentation></xs:annotation></xs:element>
Child items are of type DisplayedType. They may include items of type SectionType, QuestionType, InjectFormType, DisplayedType and ButtonType, in any order.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:element name="ChildItems" type="ChildItemsType" minOccurs="0"><xs:annotation><xs:documentation>Child items are of type DisplayedType. They may include items of type SectionType, QuestionType, InjectFormType, DisplayedType and ButtonType, in any order.</xs:documentation></xs:annotation></xs:element>
If the ID does not use the default base URI (namespace), then the local baseURI goes here. Note that all IDs must be unique within a form, even if they do not have the same baseURI. Ideally, the baseURI + ID should combine to form a *globally* unique identifier, that uniquely identifies an item in a particular form. The same baseURI and ID may be reused in derived or versioned forms, as long as the context stays the same, and any affected data elements remain unchanged in context and semantics. Following this approach is likely to simplify analytics based on form content.
A globally unique string assigned to a repeating Question or Section, Injected Form, or any selected answer ListItem. This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among sections or questions, including those that are allowed to repeat and nest deeply.
@maxCard is the maximum number of repetitions allowed for a section or question. The default value is 1, indicating that the section or question cannot be repeated on the data entry form. A value of 0 indicates that the number of repeats is unlimited. If @maxCard is not 0, then Must be greater than or equal to minCard.
@minCard is the minimum number of repetitions allowed for a section or question. The default value is 1, indicating that the user must answer any question(s) that has this attribute set. If @minCard is set to 0, then the item and all descendent questions are optional to answer.
If this attribute is set to "true" (the default), then the form implementation must make this item available for use on the form. If this attribute is set to "false" on a parent or ancestor item, then all child/descendant items inherit this "false" setting, even if they have this attribute set to "true." In other words, the child/descendent items do not need to be implemented if any parent/ancestor item has this attribute set to false.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
A globally unique string assigned from a Section, Question, ListItem or InjectedForm to the ID of its parent node (S, Q, LI or IF). This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among the above objects, including those that are allowed to repeat and nest deeply.
Allows the form filler to specify whether the current response is the initial response, or records the type of change made since the initial response was reported.
CHANGED to T/F/OptionalIf @showInReport on a Question is false, then the Question and its ListItems (if any) should not be present in a typical report derived from this template. If this attribute appears on a ListItem, then the entire question and all ListItems should be omitted from the report. If this attribute appears on a Section, then the entire Section and all Section contents (descendents) should be omitted from the report. If @showInReport appears on a DisplayedItem, then the DisplayedItem (and all sub-items) should be omitted from the report.This attribute is usually set to false when a Question is used to control form behavior (e.g., skip logic), or when the Question provides unhelpful "negative" information about actions that did not occur or were not performed, or things that were not observed.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Determines whether the item should be visible on a computer screen when the form is first displayed.
Source
<xs:element minOccurs="0" name="Section" type="SectionItemType"><xs:annotation><xs:documentation>A Section is a grouper for other types of objects.</xs:documentation></xs:annotation></xs:element>
A Question may take 3 basic forms: QS: single-select answer responseQM: multi-select - more than one answer may be selectedQF: fill-in response; no answer choices are present for selectionQS and QM are associated with a ListField of answer choices. The ListField may contain a List with ListItems (expicitly stated answer choices), or it may contain a LookupEndpoint field that populates the list from a web service.See @maxSelections on ListField for information on distinguishing QS from QM.QF is identified by the presence of a ResponseField child, which describes how the fill-in response should be recorded.
If the ID does not use the default base URI (namespace), then the local baseURI goes here. Note that all IDs must be unique within a form, even if they do not have the same baseURI. Ideally, the baseURI + ID should combine to form a *globally* unique identifier, that uniquely identifies an item in a particular form. The same baseURI and ID may be reused in derived or versioned forms, as long as the context stays the same, and any affected data elements remain unchanged in context and semantics. Following this approach is likely to simplify analytics based on form content.
A globally unique string assigned to a repeating Question or Section, Injected Form, or any selected answer ListItem. This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among sections or questions, including those that are allowed to repeat and nest deeply.
@maxCard is the maximum number of repetitions allowed for a section or question. The default value is 1, indicating that the section or question cannot be repeated on the data entry form. A value of 0 indicates that the number of repeats is unlimited. If @maxCard is not 0, then Must be greater than or equal to minCard.
@minCard is the minimum number of repetitions allowed for a section or question. The default value is 1, indicating that the user must answer any question(s) that has this attribute set. If @minCard is set to 0, then the item and all descendent questions are optional to answer.
If this attribute is set to "true" (the default), then the form implementation must make this item available for use on the form. If this attribute is set to "false" on a parent or ancestor item, then all child/descendant items inherit this "false" setting, even if they have this attribute set to "true." In other words, the child/descendent items do not need to be implemented if any parent/ancestor item has this attribute set to false.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
A globally unique string assigned from a Section, Question, ListItem or InjectedForm to the ID of its parent node (S, Q, LI or IF). This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among the above objects, including those that are allowed to repeat and nest deeply.
If @readOnly is set to true, the this field may not be edited by the user, and any default values set by template should be considered part of the stored data set responses, and transmitted by the SubmitForm transaction.
Allows the form filler to specify whether the current response is the initial response, or records the type of change made since the initial response was reported.
CHANGED to T/F/OptionalIf @showInReport on a Question is false, then the Question and its ListItems (if any) should not be present in a typical report derived from this template. If this attribute appears on a ListItem, then the entire question and all ListItems should be omitted from the report. If this attribute appears on a Section, then the entire Section and all Section contents (descendents) should be omitted from the report. If @showInReport appears on a DisplayedItem, then the DisplayedItem (and all sub-items) should be omitted from the report.This attribute is usually set to false when a Question is used to control form behavior (e.g., skip logic), or when the Question provides unhelpful "negative" information about actions that did not occur or were not performed, or things that were not observed.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Determines whether the item should be visible on a computer screen when the form is first displayed.
Source
<xs:element minOccurs="0" name="Question" type="QuestionItemType"><xs:annotation><xs:documentation>A Question may take 3 basic forms: QS: single-select answer response QM: multi-select - more than one answer may be selected QF: fill-in response; no answer choices are present for selection QS and QM are associated with a ListField of answer choices. The ListField may contain a List with ListItems (expicitly stated answer choices), or it may contain a LookupEndpoint field that populates the list from a web service. See @maxSelections on ListField for information on distinguishing QS from QM. QF is identified by the presence of a ResponseField child, which describes how the fill-in response should be recorded.</xs:documentation></xs:annotation></xs:element>
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:element name="Response" type="DataTypes_DEType" minOccurs="1" maxOccurs="1"><xs:annotation><xs:documentation>W3C Schema data type details</xs:documentation></xs:annotation></xs:element>
Defines the data type held by a string value.Also defines the dataType for list items in a list, which uses the generic string type, since string can represent any XML data type. List items of any data type should be validated by the implementation software, since all data types are written into an XML list of type string.For typed items included by reference to an external (reference or variable) value, use short name strings preceded by "$".
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Defines the data type held by a string value.Also defines the dataType for list items in a list, which uses the generic string type, since string can represent any XML data type. List items of any data type should be validated by the implementation software, since all data types are written into an XML list of type string.For typed items included by reference to an external (reference or variable) value, use short name strings preceded by "$".
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
TextAfterResponse is fixed text that appears after (to the right of) the user's response on the data entry form. This may be text for units such as "mm", "cm", etc.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
<xs:element name="TextAfterResponse" type="RichTextType" minOccurs="0" maxOccurs="1"><xs:annotation><xs:documentation>TextAfterResponse is fixed text that appears after (to the right of) the user's response on the data entry form. This may be text for units such as "mm", "cm", etc.</xs:documentation></xs:annotation></xs:element>
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Optional message that appears when the rule evaluates to true
Source
<xs:element maxOccurs="unbounded" name="AfterChange" type="EventType" minOccurs="0"><xs:annotation><xs:documentation>Event that occurs after the Response value is changed, usually fired after a user leaves the Response field.</xs:documentation></xs:annotation></xs:element>
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Data type enumeration derived from W3C XML Schema. This element is used only if the ListItems are all associated with coded values from a single coding system.
Maximum number of answer choices (list items) that can be selected by the user. Must be greater than or equal to minSelections, and no larger than the total number of list items. A value of 0 indicates no limit to the number of selected list items (answers). This effectively means that the question is multi-select. (Abbreviated as QM)A value of 1 (the default) indicates that the question list is single-select. (Abbreviated as QS)
Minimum number of answer choices (list items) that must be selected by the user. Default value is 1.NEW: changed minimum value to 1.Removed: If set to 0, then this question need not be answered by the user.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
<xs:element minOccurs="0" name="ListHeaderText" type="RichTextType"><xs:annotation><xs:documentation>The header row for a set of list items. If the list has more than one column, the column text is separated by the colTextDelimiter.</xs:documentation></xs:annotation></xs:element>
If coded values are used for items in a List (including ListItem and LookupEndPoint lists), then the default coding system should be specified here. For ListItem nodes, any exceptions to the coding system may be specified on the individual ListItem nodes. For LookupEndPoints, the endpoint data can optionally specify any exceptions in a dedicated CodeSystem column in the returned list data.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:element maxOccurs="1" minOccurs="0" name="DefaultCodeSystem" type="CodeSystemType"><xs:annotation><xs:documentation>If coded values are used for items in a List (including ListItem and LookupEndPoint lists), then the default coding system should be specified here. For ListItem nodes, any exceptions to the coding system may be specified on the individual ListItem nodes. For LookupEndPoints, the endpoint data can optionally specify any exceptions in a dedicated CodeSystem column in the returned list data.</xs:documentation></xs:annotation></xs:element>
List refers to a set of possible answer choices for the user to select. Child DisplayedItems may be interspersed with Child ListItems. At least one ListItem must be present for a multi-select question, and at least two ListItems must pre present for single-select questions.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:element name="List" type="ListType"><xs:annotation><xs:documentation>List refers to a set of possible answer choices for the user to select. Child DisplayedItems may be interspersed with Child ListItems. At least one ListItem must be present for a multi-select question, and at least two ListItems must pre present for single-select questions.</xs:documentation></xs:annotation></xs:element>
If the ID does not use the default base URI (namespace), then the local baseURI goes here. Note that all IDs must be unique within a form, even if they do not have the same baseURI. Ideally, the baseURI + ID should combine to form a *globally* unique identifier, that uniquely identifies an item in a particular form. The same baseURI and ID may be reused in derived or versioned forms, as long as the context stays the same, and any affected data elements remain unchanged in context and semantics. Following this approach is likely to simplify analytics based on form content.
If this attribute is set to "true" (the default), then the form implementation must make this item available for use on the form. If this attribute is set to "false" on a parent or ancestor item, then all child/descendant items inherit this "false" setting, even if they have this attribute set to "true." In other words, the child/descendent items do not need to be implemented if any parent/ancestor item has this attribute set to false.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
CHANGED to T/F/OptionalIf @showInReport on a Question is false, then the Question and its ListItems (if any) should not be present in a typical report derived from this template. If this attribute appears on a ListItem, then the entire question and all ListItems should be omitted from the report. If this attribute appears on a Section, then the entire Section and all Section contents (descendents) should be omitted from the report. If @showInReport appears on a DisplayedItem, then the DisplayedItem (and all sub-items) should be omitted from the report.This attribute is usually set to false when a Question is used to control form behavior (e.g., skip logic), or when the Question provides unhelpful "negative" information about actions that did not occur or were not performed, or things that were not observed.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
A typed value (e.g., an integer) that is uniquely associated with a ListItem. An example is the integer 10 for a ListItem with title that reads "10 o'clock". Typically these values are set to be used in calculations or other algorithms. In general, they can be treated something like a user-entered response on a the ListItemResponseField of a selected ListItem.This field should not be used for terminologies or local codes. The CodedValue type should be used for these kinds of metadata. This field should also not be used other properties such as translations, usage, etc.The data type shoudl be specified in @AssociatedValueType
If the ID does not use the default base URI (namespace), then the local baseURI goes here. Note that all IDs must be unique within a form, even if they do not have the same baseURI. Ideally, the baseURI + ID should combine to form a *globally* unique identifier, that uniquely identifies an item in a particular form. The same baseURI and ID may be reused in derived or versioned forms, as long as the context stays the same, and any affected data elements remain unchanged in context and semantics. Following this approach is likely to simplify analytics based on form content.
A globally unique string assigned to a repeating Question or Section, Injected Form, or any selected answer ListItem. This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among sections or questions, including those that are allowed to repeat and nest deeply.
If this attribute is set to "true" (the default), then the form implementation must make this item available for use on the form. If this attribute is set to "false" on a parent or ancestor item, then all child/descendant items inherit this "false" setting, even if they have this attribute set to "true." In other words, the child/descendent items do not need to be implemented if any parent/ancestor item has this attribute set to false.
NEW: If @omitWhenSelected is set to true, then the question and its response(s) should not be present in a typical report derived from this template. This attribute is usually set to true when the answer choice is used to control form behavior (e.g., skip logic), or when the question provides unhelpful "negative" information about actions that did not occur or were not performed, or things that were not observed or could not be assessed. If @omitWhenSelectedset is false (default) then the question and its response(s) should appear in the report. Added 11/29/15 to replace @reportAction
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
A globally unique string assigned from a Section, Question, ListItem or InjectedForm to the ID of its parent node (S, Q, LI or IF). This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among the above objects, including those that are allowed to repeat and nest deeply.
Represents the default value of the ListItem in the FormDesign template, or the user's response in selecting one or more ListItems. If @multiSelect='false' on ListField then only one item may be selected.
NEWSelecting the current ListItem will enable the named items in this attribute's content.Prefixing any named with a hyphen (-) will reverse the above behaviour (i.e., the named items will be disabled).Unselecting the ListItem will reverse this behaviour.Prefixing the name with a tilde (~) will supress this reversal behavior.
If the ancestor ListField has @multiselect = 'true', then selecting this ListItem should de-select all other ListItem (sibling) nodes except the current one.
If set to true, then selecting this ListItem must deactivate all descendant parts of the form, and ignore any user-entered values in the deactivated part. Deselecting the ListItem should reactivate the descendant items in their state at the time the items were deactivated.If items are disabled, then any data stored in the disabled questions should be removed.
NEWSelecting the current ListItem will select the named ListItems in this attribute's content.Prefixing any named with a hyphen (-) will reverse the above behaviour.Unselecting the ListItem will reverse this behaviour.Prefixing the name with a tilde (~) will suppress this reversal behavior.
CHANGED to T/F/OptionalIf @showInReport on a Question is false, then the Question and its ListItems (if any) should not be present in a typical report derived from this template. If this attribute appears on a ListItem, then the entire question and all ListItems should be omitted from the report. If this attribute appears on a Section, then the entire Section and all Section contents (descendents) should be omitted from the report. If @showInReport appears on a DisplayedItem, then the DisplayedItem (and all sub-items) should be omitted from the report.This attribute is usually set to false when a Question is used to control form behavior (e.g., skip logic), or when the Question provides unhelpful "negative" information about actions that did not occur or were not performed, or things that were not observed.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:element name="ListItemResponseField" minOccurs="0" maxOccurs="1" type="ListItemResponseFieldType"><xs:annotation><xs:documentation>A place to enter values (of any data type) that are directly associated with, and attached to, a selected answer choice.</xs:documentation></xs:annotation></xs:element>
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
LookupEndPoint is used when the list items are derived from a web service call of some type, instead of an explicit set of ListItem nodes specified in the FormDesign XML. The endpoint must return a list separated into individual list items by the @colTextDelimiter value specified in the parent ListFieldType.
Defines the data type held by a string value.Also defines the dataType for list items in a list, which uses the generic string type, since string can represent any XML data type. List items of any data type should be validated by the implementation software, since all data types are written into an XML list of type string.For typed items included by reference to an external (reference or variable) value, use short name strings preceded by "$".
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:element name="LookupEndPoint" minOccurs="1" maxOccurs="1" type="LookupEndPointType"><xs:annotation><xs:documentation>LookupEndPoint is used when the list items are derived from a web service call of some type, instead of an explicit set of ListItem nodes specified in the FormDesign XML. The endpoint must return a list separated into individual list items by the @colTextDelimiter value specified in the parent ListFieldType.</xs:documentation></xs:annotation></xs:element>
The user's response to the lookup list. The response is recorded as a coding, terminology, classification, keyword, or local value. Multiple selections from the lookup list may be allowed.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:element maxOccurs="unbounded" minOccurs="0" name="ResponseValue" type="CodingType"><xs:annotation><xs:documentation>The user's response to the lookup list. The response is recorded as a coding, terminology, classification, keyword, or local value. Multiple selections from the lookup list may be allowed.</xs:documentation></xs:annotation></xs:element>
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The ListItem that is being evaluated for the presence of disallowed selections (in @listItemNames). This attributes contains the @name of one ListItem.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Optional message that appears when the rule evaluates to true
Source
<xs:element minOccurs="0" name="AfterChange" maxOccurs="unbounded" type="EventType"><xs:annotation><xs:documentation>Event that occurs after List Field selections are changed.</xs:documentation></xs:annotation></xs:element>
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
The DisplayedItem contains title, Blob (Binary Large Object), and/or Link content, and may also include Contacts and CodedValues that relate to the Note/Blob/Link objects. DisplayedItems may be interspersed with other MainItems or ListItem nodes. The parent items may be Section, Question, and ListItem. However, DisplayedItems are not "attached" to any specific item Section, Question, or ListItem. Instead they are free-floating items that can appear anywhere on a form, such as between ListItem nodes.
If the ID does not use the default base URI (namespace), then the local baseURI goes here. Note that all IDs must be unique within a form, even if they do not have the same baseURI. Ideally, the baseURI + ID should combine to form a *globally* unique identifier, that uniquely identifies an item in a particular form. The same baseURI and ID may be reused in derived or versioned forms, as long as the context stays the same, and any affected data elements remain unchanged in context and semantics. Following this approach is likely to simplify analytics based on form content.
If this attribute is set to "true" (the default), then the form implementation must make this item available for use on the form. If this attribute is set to "false" on a parent or ancestor item, then all child/descendant items inherit this "false" setting, even if they have this attribute set to "true." In other words, the child/descendent items do not need to be implemented if any parent/ancestor item has this attribute set to false.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
CHANGED to T/F/OptionalIf @showInReport on a Question is false, then the Question and its ListItems (if any) should not be present in a typical report derived from this template. If this attribute appears on a ListItem, then the entire question and all ListItems should be omitted from the report. If this attribute appears on a Section, then the entire Section and all Section contents (descendents) should be omitted from the report. If @showInReport appears on a DisplayedItem, then the DisplayedItem (and all sub-items) should be omitted from the report.This attribute is usually set to false when a Question is used to control form behavior (e.g., skip logic), or when the Question provides unhelpful "negative" information about actions that did not occur or were not performed, or things that were not observed.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Determines whether the item should be visible on a computer screen when the form is first displayed.
Source
<xs:element minOccurs="0" name="DisplayedItem" type="DisplayedType"><xs:annotation><xs:documentation>The DisplayedItem contains title, Blob (Binary Large Object), and/or Link content, and may also include Contacts and CodedValues that relate to the Note/Blob/Link objects. DisplayedItems may be interspersed with other MainItems or ListItem nodes. The parent items may be Section, Question, and ListItem. However, DisplayedItems are not "attached" to any specific item Section, Question, or ListItem. Instead they are free-floating items that can appear anywhere on a form, such as between ListItem nodes.</xs:documentation></xs:annotation></xs:element>
A Button is a visible area that can be selected ("clicked") to trigger event code to perform an action. It is ordinarily implemented with an image that looks like a rectangular button object, but a button can look like anything.
If the ID does not use the default base URI (namespace), then the local baseURI goes here. Note that all IDs must be unique within a form, even if they do not have the same baseURI. Ideally, the baseURI + ID should combine to form a *globally* unique identifier, that uniquely identifies an item in a particular form. The same baseURI and ID may be reused in derived or versioned forms, as long as the context stays the same, and any affected data elements remain unchanged in context and semantics. Following this approach is likely to simplify analytics based on form content.
If this attribute is set to "true" (the default), then the form implementation must make this item available for use on the form. If this attribute is set to "false" on a parent or ancestor item, then all child/descendant items inherit this "false" setting, even if they have this attribute set to "true." In other words, the child/descendent items do not need to be implemented if any parent/ancestor item has this attribute set to false.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
CHANGED to T/F/OptionalIf @showInReport on a Question is false, then the Question and its ListItems (if any) should not be present in a typical report derived from this template. If this attribute appears on a ListItem, then the entire question and all ListItems should be omitted from the report. If this attribute appears on a Section, then the entire Section and all Section contents (descendents) should be omitted from the report. If @showInReport appears on a DisplayedItem, then the DisplayedItem (and all sub-items) should be omitted from the report.This attribute is usually set to false when a Question is used to control form behavior (e.g., skip logic), or when the Question provides unhelpful "negative" information about actions that did not occur or were not performed, or things that were not observed.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Determines whether the item should be visible on a computer screen when the form is first displayed.
Source
<xs:element minOccurs="0" name="ButtonAction" type="ButtonItemType"><xs:annotation><xs:documentation>A Button is a visible area that can be selected ("clicked") to trigger event code to perform an action. It is ordinarily implemented with an image that looks like a rectangular button object, but a button can look like anything.</xs:documentation></xs:annotation></xs:element>
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
If the ID does not use the default base URI (namespace), then the local baseURI goes here. Note that all IDs must be unique within a form, even if they do not have the same baseURI. Ideally, the baseURI + ID should combine to form a *globally* unique identifier, that uniquely identifies an item in a particular form. The same baseURI and ID may be reused in derived or versioned forms, as long as the context stays the same, and any affected data elements remain unchanged in context and semantics. Following this approach is likely to simplify analytics based on form content.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
DRAFT: The baseURI of the package, whihc indicates the home source of the package. The formManagerURP + pkgBaseURI + pkgID are concatenated to retrieve an empty form. formManagerURP + pkgBaseURI + pkgInstanceVersionURI are concatenated to retrieve a specific version of a populated form. formManagerURP + pkgBaseURI + pkgInstanceURI are concatenated to retrieve the latest instance of a populated form.
NEW: Unique URI used to identify a unique instance of a package. Used for tracking form responses across time and across multiple episodes of editing by end-users. This URI does not change for each edit session of a package instance.
NEW: Unique URI used to identify a unique instance of a package's saved responses. It is used for tracking package responses across time and across multiple episodes of editing by end-users. This URI must change for each edit/save session of a package instance. It may be e.g., a new GUID, or a repeat of the pkgInstanceID followed by a version number.
The rootItemID is the ID of the form part that will be injected. If empty, then the entre form should be injected as the FormDesign element node. If not empty, it must point to a valid Section or Question.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:element minOccurs="0" name="InjectForm" type="InjectFormType"><xs:annotation><xs:documentation>InjectForm is a link to a form (or portion of a form) that is imported into the current form at specific sites.</xs:documentation></xs:annotation></xs:element>
If the ID does not use the default base URI (namespace), then the local baseURI goes here. Note that all IDs must be unique within a form, even if they do not have the same baseURI. Ideally, the baseURI + ID should combine to form a *globally* unique identifier, that uniquely identifies an item in a particular form. The same baseURI and ID may be reused in derived or versioned forms, as long as the context stays the same, and any affected data elements remain unchanged in context and semantics. Following this approach is likely to simplify analytics based on form content.
A globally unique string assigned to a repeating Question or Section, Injected Form, or any selected answer ListItem. This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among sections or questions, including those that are allowed to repeat and nest deeply.
@maxCard is the maximum number of repetitions allowed for a section or question. The default value is 1, indicating that the section or question cannot be repeated on the data entry form. A value of 0 indicates that the number of repeats is unlimited. If @maxCard is not 0, then Must be greater than or equal to minCard.
@minCard is the minimum number of repetitions allowed for a section or question. The default value is 1, indicating that the user must answer any question(s) that has this attribute set. If @minCard is set to 0, then the item and all descendent questions are optional to answer.
If this attribute is set to "true" (the default), then the form implementation must make this item available for use on the form. If this attribute is set to "false" on a parent or ancestor item, then all child/descendant items inherit this "false" setting, even if they have this attribute set to "true." In other words, the child/descendent items do not need to be implemented if any parent/ancestor item has this attribute set to false.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
A globally unique string assigned from a Section, Question, ListItem or InjectedForm to the ID of its parent node (S, Q, LI or IF). This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among the above objects, including those that are allowed to repeat and nest deeply.
If @readOnly is set to true, the this field may not be edited by the user, and any default values set by template should be considered part of the stored data set responses, and transmitted by the SubmitForm transaction.
Allows the form filler to specify whether the current response is the initial response, or records the type of change made since the initial response was reported.
CHANGED to T/F/OptionalIf @showInReport on a Question is false, then the Question and its ListItems (if any) should not be present in a typical report derived from this template. If this attribute appears on a ListItem, then the entire question and all ListItems should be omitted from the report. If this attribute appears on a Section, then the entire Section and all Section contents (descendents) should be omitted from the report. If @showInReport appears on a DisplayedItem, then the DisplayedItem (and all sub-items) should be omitted from the report.This attribute is usually set to false when a Question is used to control form behavior (e.g., skip logic), or when the Question provides unhelpful "negative" information about actions that did not occur or were not performed, or things that were not observed.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
If the ID does not use the default base URI (namespace), then the local baseURI goes here. Note that all IDs must be unique within a form, even if they do not have the same baseURI. Ideally, the baseURI + ID should combine to form a *globally* unique identifier, that uniquely identifies an item in a particular form. The same baseURI and ID may be reused in derived or versioned forms, as long as the context stays the same, and any affected data elements remain unchanged in context and semantics. Following this approach is likely to simplify analytics based on form content.
NEW: URI used to identify the form that that this FormDesign is based upon. In most cases, this should be a standard form that is modified and/or extended by the current FormDesign. The current template reuses the basedOn IDs whenever the question/answer/semantic context is identical to the original.5/11/17: Relying on data element mapping may be a better and more flexible approach than @basedOnURI. In this way, forms could compare data elements to determine if they contain semantic matches, and this is supported better with a more robust code map section.
NEW: filename to use when the current FormDesign instance is saved as a file. For forms containing responses, the filename may include the formInstanceVersionURI, but the naming convention may be use-case-specific.
NEW: Unique URI used to identify a unique instance of a form. Used for tracking form responses across time and across multiple episodes of editing by end-users. This URI does not change for each edit session of a form instance.
NEW: Unique URI used to identify a unique instance of a form's saved responses. It is used for tracking form responses across time and across multiple episodes of editing by end-users. This URI must change for each edit/save session of a form instance. It may be e.g., a new GUID, or a repeat of the formInstanceID followed by a version number.
NEW: Unique URI used to identify the immediate previous instance of a form containing responses. This is the @formInstanceVersionURI that represents the instance of the form that the user opened up before beginning a new cycle of edit/save. This attribute is used for tracking form responses across time and across multiple episodes of editing by end-users. This URI must change for each edit session of a form instance.
NEW: The full URI that uniquely identifies the current form. It is created by concatenating @baseURI + lineage + version. Each of the componenets is separated by a single forward slash.
NEW: A text identifier that is used to group multiple versions of a single form. The lineage is constant for all versions of a single kind of form. When appended to @baseURI, it can be used to retrieve all versions of one particular form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
Allows the form filler to specify whether the current response is the initial response, or records the type of change made since the initial response was reported.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
NEW:This event is fired after the page is loaded into memory, before stored form data is loaded, and before the form is visible. For example, It may be used to determine the data to be loaded and to perform the data loading.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Optional message that appears when the rule evaluates to true
Source
<xs:element minOccurs="0" name="BeforeLoadData" type="EventType"><xs:annotation><xs:documentation>NEW: This event is fired after the page is loaded into memory, before stored form data is loaded, and before the form is visible. For example, It may be used to determine the data to be loaded and to perform the data loading.</xs:documentation></xs:annotation></xs:element>
NEW:This event is fired after the page is loaded is memory, after the data is loaded into the form, but before the form is displayed. It may be used to perform form activities that are controlled by the loaded data.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Optional message that appears when the rule evaluates to true
Source
<xs:element minOccurs="0" name="BeforeShowForm" type="EventType"><xs:annotation><xs:documentation>NEW: This event is fired after the page is loaded is memory, after the data is loaded into the form, but before the form is displayed. It may be used to perform form activities that are controlled by the loaded data.</xs:documentation></xs:annotation></xs:element>
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
If the ID does not use the default base URI (namespace), then the local baseURI goes here. Note that all IDs must be unique within a form, even if they do not have the same baseURI. Ideally, the baseURI + ID should combine to form a *globally* unique identifier, that uniquely identifies an item in a particular form. The same baseURI and ID may be reused in derived or versioned forms, as long as the context stays the same, and any affected data elements remain unchanged in context and semantics. Following this approach is likely to simplify analytics based on form content.
A globally unique string assigned to a repeating Question or Section, Injected Form, or any selected answer ListItem. This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among sections or questions, including those that are allowed to repeat and nest deeply.
@maxCard is the maximum number of repetitions allowed for a section or question. The default value is 1, indicating that the section or question cannot be repeated on the data entry form. A value of 0 indicates that the number of repeats is unlimited. If @maxCard is not 0, then Must be greater than or equal to minCard.
@minCard is the minimum number of repetitions allowed for a section or question. The default value is 1, indicating that the user must answer any question(s) that has this attribute set. If @minCard is set to 0, then the item and all descendent questions are optional to answer.
If this attribute is set to "true" (the default), then the form implementation must make this item available for use on the form. If this attribute is set to "false" on a parent or ancestor item, then all child/descendant items inherit this "false" setting, even if they have this attribute set to "true." In other words, the child/descendent items do not need to be implemented if any parent/ancestor item has this attribute set to false.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
A globally unique string assigned from a Section, Question, ListItem or InjectedForm to the ID of its parent node (S, Q, LI or IF). This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among the above objects, including those that are allowed to repeat and nest deeply.
Allows the form filler to specify whether the current response is the initial response, or records the type of change made since the initial response was reported.
CHANGED to T/F/OptionalIf @showInReport on a Question is false, then the Question and its ListItems (if any) should not be present in a typical report derived from this template. If this attribute appears on a ListItem, then the entire question and all ListItems should be omitted from the report. If this attribute appears on a Section, then the entire Section and all Section contents (descendents) should be omitted from the report. If @showInReport appears on a DisplayedItem, then the DisplayedItem (and all sub-items) should be omitted from the report.This attribute is usually set to false when a Question is used to control form behavior (e.g., skip logic), or when the Question provides unhelpful "negative" information about actions that did not occur or were not performed, or things that were not observed.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Determines whether the item should be visible on a computer screen when the form is first displayed.
Source
<xs:element name="Header" type="SectionItemType" minOccurs="0" maxOccurs="1"><xs:annotation><xs:documentation>Optional Section that stays at the top of a form.</xs:documentation></xs:annotation></xs:element>
If the ID does not use the default base URI (namespace), then the local baseURI goes here. Note that all IDs must be unique within a form, even if they do not have the same baseURI. Ideally, the baseURI + ID should combine to form a *globally* unique identifier, that uniquely identifies an item in a particular form. The same baseURI and ID may be reused in derived or versioned forms, as long as the context stays the same, and any affected data elements remain unchanged in context and semantics. Following this approach is likely to simplify analytics based on form content.
A globally unique string assigned to a repeating Question or Section, Injected Form, or any selected answer ListItem. This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among sections or questions, including those that are allowed to repeat and nest deeply.
@maxCard is the maximum number of repetitions allowed for a section or question. The default value is 1, indicating that the section or question cannot be repeated on the data entry form. A value of 0 indicates that the number of repeats is unlimited. If @maxCard is not 0, then Must be greater than or equal to minCard.
@minCard is the minimum number of repetitions allowed for a section or question. The default value is 1, indicating that the user must answer any question(s) that has this attribute set. If @minCard is set to 0, then the item and all descendent questions are optional to answer.
If this attribute is set to "true" (the default), then the form implementation must make this item available for use on the form. If this attribute is set to "false" on a parent or ancestor item, then all child/descendant items inherit this "false" setting, even if they have this attribute set to "true." In other words, the child/descendent items do not need to be implemented if any parent/ancestor item has this attribute set to false.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
A globally unique string assigned from a Section, Question, ListItem or InjectedForm to the ID of its parent node (S, Q, LI or IF). This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among the above objects, including those that are allowed to repeat and nest deeply.
Allows the form filler to specify whether the current response is the initial response, or records the type of change made since the initial response was reported.
CHANGED to T/F/OptionalIf @showInReport on a Question is false, then the Question and its ListItems (if any) should not be present in a typical report derived from this template. If this attribute appears on a ListItem, then the entire question and all ListItems should be omitted from the report. If this attribute appears on a Section, then the entire Section and all Section contents (descendents) should be omitted from the report. If @showInReport appears on a DisplayedItem, then the DisplayedItem (and all sub-items) should be omitted from the report.This attribute is usually set to false when a Question is used to control form behavior (e.g., skip logic), or when the Question provides unhelpful "negative" information about actions that did not occur or were not performed, or things that were not observed.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
If the ID does not use the default base URI (namespace), then the local baseURI goes here. Note that all IDs must be unique within a form, even if they do not have the same baseURI. Ideally, the baseURI + ID should combine to form a *globally* unique identifier, that uniquely identifies an item in a particular form. The same baseURI and ID may be reused in derived or versioned forms, as long as the context stays the same, and any affected data elements remain unchanged in context and semantics. Following this approach is likely to simplify analytics based on form content.
A globally unique string assigned to a repeating Question or Section, Injected Form, or any selected answer ListItem. This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among sections or questions, including those that are allowed to repeat and nest deeply.
@maxCard is the maximum number of repetitions allowed for a section or question. The default value is 1, indicating that the section or question cannot be repeated on the data entry form. A value of 0 indicates that the number of repeats is unlimited. If @maxCard is not 0, then Must be greater than or equal to minCard.
@minCard is the minimum number of repetitions allowed for a section or question. The default value is 1, indicating that the user must answer any question(s) that has this attribute set. If @minCard is set to 0, then the item and all descendent questions are optional to answer.
If this attribute is set to "true" (the default), then the form implementation must make this item available for use on the form. If this attribute is set to "false" on a parent or ancestor item, then all child/descendant items inherit this "false" setting, even if they have this attribute set to "true." In other words, the child/descendent items do not need to be implemented if any parent/ancestor item has this attribute set to false.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
A globally unique string assigned from a Section, Question, ListItem or InjectedForm to the ID of its parent node (S, Q, LI or IF). This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among the above objects, including those that are allowed to repeat and nest deeply.
Allows the form filler to specify whether the current response is the initial response, or records the type of change made since the initial response was reported.
CHANGED to T/F/OptionalIf @showInReport on a Question is false, then the Question and its ListItems (if any) should not be present in a typical report derived from this template. If this attribute appears on a ListItem, then the entire question and all ListItems should be omitted from the report. If this attribute appears on a Section, then the entire Section and all Section contents (descendents) should be omitted from the report. If @showInReport appears on a DisplayedItem, then the DisplayedItem (and all sub-items) should be omitted from the report.This attribute is usually set to false when a Question is used to control form behavior (e.g., skip logic), or when the Question provides unhelpful "negative" information about actions that did not occur or were not performed, or things that were not observed.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Determines whether the item should be visible on a computer screen when the form is first displayed.
Source
<xs:element name="Footer" type="SectionItemType" minOccurs="0" maxOccurs="1"><xs:annotation><xs:documentation>Optional Section that stays at the bottom of a form.</xs:documentation></xs:annotation></xs:element>
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The ListItem that is being evaluated for the presence of disallowed selections (in @listItemNames). This attributes contains the @name of one ListItem.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
List of names of Sections, Questions, ListItems and/or InjectedItems. Each of the named items will evaluate to true or false, based on the following validation rules:If the name points to a Section, then the Section evaluates to true (valid) if all of its descendant items are answered correctly, according to their metadata.If the name points to a Question then the Question evaluates to true (valid) if it is correctly answered according to its metadata, and also, all descendant items are answered correctly, according to their metadata.If the name points to a ListItem then the ListItem evaluates to true (valid) if it is selected, and also, all descendant items are answered correctly according to their metadata.If the name points to an InjectedItem then the InjectedItem evaluates to true (valid) if all descendant items are answered correctly, according to their metadata.The number of true responses are added together. If they satisfy the minAnswered and maxAnswered attribute values, then this type returns true. Otherwise it returns false.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
(reversible); If onlyIf is true, then the stipulated Boolean actions, which are executed when the If conditions evaluate to true, are reversed when the conditions evaluate to false.If onlyIf="true", the target items assume the chosen attribute values (e.g., selected, activated) ONLY when the action condition(s) are satisfied. If the conditions are not satisfied, then all Boolean actions assume the opposite state (e.g., unselected, inactive).Manually changing the attributes on the target item (upon which the actions are executed) will not affect any attributes in the controlling items. It is possible to disable (enabled="false") the target item so that its attributes can only be be changed programmatically.The default value is "false" indicating that the the rule runs when the "If" condition is "true." The attached action will not reverse (be undone) when the "If" condition evaluates to "false."
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
Delete all user selections, responses and comments when the item is deactivated. Applies to all descendant items as well. User should be warned before deleting anything, with an option to preserve the responses in the disabled items. Disabled item responses should not be saved with the form data.
This list contains names of ListItems (answer choices) that are watched for being selected or unselected.If a ListItem appears in this list, then it evaluates to true when it is selected. If a ListItem is prefixed with a hyphen (-), then it evaluates to true when unselected. These Boolean values, derived from each named ListItem in the list, are ANDed together (by default) to produce a return value of true or false. The default Boolean operator (AND) may be changed using @boolOp. If @not = true, then the Boolean result is logically negated.Renamed from: ListItemSelections
This list contains the @names of Identified Items that will be automatically activated or deactivated when the @selectedItemSet evaluates to true. If a @name is prefixed with a hyphen (-), then the item will be deactivated when @selectedItemSet evaluates to true. If @not = true, then the Boolean rule evaluation is negated, and thus the rule works in reverse.If @onlyIf is true, then the above rule is reversed when @selectedItemSet evaluates to false. In other words, named items will be deactivated, and hyphen-prefixed items will be activated when @selectedItemSet is false.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
(reversible); If onlyIf is true, then the stipulated Boolean actions, which are executed when the If conditions evaluate to true, are reversed when the conditions evaluate to false.If onlyIf="true", the target items assume the chosen attribute values (e.g., selected, activated) ONLY when the action condition(s) are satisfied. If the conditions are not satisfied, then all Boolean actions assume the opposite state (e.g., unselected, inactive).Manually changing the attributes on the target item (upon which the actions are executed) will not affect any attributes in the controlling items. It is possible to disable (enabled="false") the target item so that its attributes can only be be changed programmatically.The default value is "false" indicating that the the rule runs when the "If" condition is "true." The attached action will not reverse (be undone) when the "If" condition evaluates to "false."
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
This list contains names of ListItems (answer choices) that are watched for being selected or unselected.If a ListItem appears in this list, then it evaluates to true when it is selected. If a ListItem is prefixed with a hyphen (-), then it evaluates to true when unselected. These Boolean values, derived from each named ListItem in the list, are ANDed together (by default) to produce a return value of true or false. The default Boolean operator (AND) may be changed using @boolOp. If @not = true, then the Boolean result is logically negated.Renamed from: ListItemSelections
This list contains the @names of ListItems that will be automatically selected or deselected when the @selectedItemSet evaluates to true. If a @name is prefixed with a hyphen (-), then the item will be deselected when @selectedItemSet evaluates to true. If @not = true, then the Boolean rule evaluation is negated, and thus the rule works in reverse.If @onlyIf is true, then the above rule is reversed when @selectedItemSet evaluates to false. In other words, named items will be deselected, and hyphen-prefixed items will be selected when @selectedItemSet is false.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Defines the data type held by a string value.Also defines the dataType for list items in a list, which uses the generic string type, since string can represent any XML data type. List items of any data type should be validated by the implementation software, since all data types are written into an XML list of type string.For typed items included by reference to an external (reference or variable) value, use short name strings preceded by "$".
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Defines the data type held by a string value.Also defines the dataType for list items in a list, which uses the generic string type, since string can represent any XML data type. List items of any data type should be validated by the implementation software, since all data types are written into an XML list of type string.For typed items included by reference to an external (reference or variable) value, use short name strings preceded by "$".
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:element maxOccurs="unbounded" minOccurs="0" name="ExternalRule" type="CallFuncType"><xs:annotation><xs:documentation>Rules that are called (by referencing the rule's @name attribute) from another place in the form.</xs:documentation></xs:annotation></xs:element>
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
This list contains names of ListItems (answer choices) that are watched for being selected or unselected.If a ListItem appears in this list, then it evaluates to true when it is selected. If a ListItem is prefixed with a hyphen (-), then it evaluates to true when unselected. These Boolean values, derived from each named ListItem in the list, are ANDed together (by default) to produce a return value of true or false. The default Boolean operator (AND) may be changed using @boolOp. If @not = true, then the Boolean result is logically negated.Renamed from: ListItemSelections
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The ListItem that is being evaluated for the presence of disallowed selections (in @listItemNames). This attributes contains the @name of one ListItem.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
If the ID does not use the default base URI (namespace), then the local baseURI goes here. Note that all IDs must be unique within a form, even if they do not have the same baseURI. Ideally, the baseURI + ID should combine to form a *globally* unique identifier, that uniquely identifies an item in a particular form. The same baseURI and ID may be reused in derived or versioned forms, as long as the context stays the same, and any affected data elements remain unchanged in context and semantics. Following this approach is likely to simplify analytics based on form content.
NEW: URI used to identify the DE that that this DE is based upon. In most cases, this should be a standard form that is modified and/or extended by the current DE. The current template reuses the basedOn IDs whenever the question/answer/semantic context is identical to the original.
NEW: filename to use when the current DE instance is saved as a file. For DEs containing responses, the filename may include the deInstanceVersionURI, but the naming convention may be use-case-specific.
NEW: The full URI that uniquely identifies the current DE. It is created by concatenating @baseURI + lineage + version. Each of the componenets is separated by a single forward slash.
NEW: Unique URI used to identify a unique instance of a DE. Used for tracking DE responses across time and across multiple episodes of editing by end-users. This URI does not change for each edit session of a DE instance.
NEW: Unique URI used to identify a unique instance of a DE's saved responses. It is used for tracking DE responses across time and across multiple episodes of editing by end-users. This URI must change for each edit/save session of a DE instance. It may be e.g., a new GUID, or a repeat of the deInstanceID followed by a version number.
NEW: A text identifier that is used to group multiple versions of a single DE. The lineage is constant for all versions of a single kind of DE. When appended to @baseURI, it can be used to retrieve all versions of one particular DE.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
NEW: Unique URI used to identify the immediate previous instance of a de containing responses. This is the @deInstanceVersionURI that represents the instance of the form that the user opened up before beginning a new cycle of edit/save. This attribute is used for tracking de responses across time and across multiple episodes of editing by end-users. This URI must change for each edit session of a de instance.
Allows the form filler to specify whether the current response is the initial response, or records the type of change made since the initial response was reported.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Start here. This is the top level of the SDCFormDesign object model. It represents the definition for the information content of a single data-entry form.
If the ID does not use the default base URI (namespace), then the local baseURI goes here. Note that all IDs must be unique within a form, even if they do not have the same baseURI. Ideally, the baseURI + ID should combine to form a *globally* unique identifier, that uniquely identifies an item in a particular form. The same baseURI and ID may be reused in derived or versioned forms, as long as the context stays the same, and any affected data elements remain unchanged in context and semantics. Following this approach is likely to simplify analytics based on form content.
NEW: URI used to identify the form that that this FormDesign is based upon. In most cases, this should be a standard form that is modified and/or extended by the current FormDesign. The current template reuses the basedOn IDs whenever the question/answer/semantic context is identical to the original.5/11/17: Relying on data element mapping may be a better and more flexible approach than @basedOnURI. In this way, forms could compare data elements to determine if they contain semantic matches, and this is supported better with a more robust code map section.
NEW: filename to use when the current FormDesign instance is saved as a file. For forms containing responses, the filename may include the formInstanceVersionURI, but the naming convention may be use-case-specific.
NEW: Unique URI used to identify a unique instance of a form. Used for tracking form responses across time and across multiple episodes of editing by end-users. This URI does not change for each edit session of a form instance.
NEW: Unique URI used to identify a unique instance of a form's saved responses. It is used for tracking form responses across time and across multiple episodes of editing by end-users. This URI must change for each edit/save session of a form instance. It may be e.g., a new GUID, or a repeat of the formInstanceID followed by a version number.
NEW: Unique URI used to identify the immediate previous instance of a form containing responses. This is the @formInstanceVersionURI that represents the instance of the form that the user opened up before beginning a new cycle of edit/save. This attribute is used for tracking form responses across time and across multiple episodes of editing by end-users. This URI must change for each edit session of a form instance.
NEW: The full URI that uniquely identifies the current form. It is created by concatenating @baseURI + lineage + version. Each of the componenets is separated by a single forward slash.
NEW: A text identifier that is used to group multiple versions of a single form. The lineage is constant for all versions of a single kind of form. When appended to @baseURI, it can be used to retrieve all versions of one particular form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
Allows the form filler to specify whether the current response is the initial response, or records the type of change made since the initial response was reported.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
NEW: @version contains the version text for the current form. It is designed to be used in conjuction with @baseURI and @lineage.
Source
<xs:complexType name="FormDesignType"><xs:annotation><xs:documentation>Start here. This is the top level of the SDCFormDesign object model. It represents the definition for the information content of a single data-entry form.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="IdentifiedExtensionType"><xs:sequence minOccurs="0"><xs:element minOccurs="0" name="BeforeLoadForm" type="EventType"><xs:annotation><xs:documentation>NEW: This event is fired before the page is loaded into memory, and before stored form data is loaded. It may be used, e.g., for authentication, to retrieve/prepare stored data, and/or to control form rendering according to user preferences.</xs:documentation></xs:annotation></xs:element><xs:element minOccurs="0" name="BeforeLoadData" type="EventType"><xs:annotation><xs:documentation>NEW: This event is fired after the page is loaded into memory, before stored form data is loaded, and before the form is visible. For example, It may be used to determine the data to be loaded and to perform the data loading.</xs:documentation></xs:annotation></xs:element><xs:element minOccurs="0" name="BeforeShowForm" type="EventType"><xs:annotation><xs:documentation>NEW: This event is fired after the page is loaded is memory, after the data is loaded into the form, but before the form is displayed. It may be used to perform form activities that are controlled by the loaded data.</xs:documentation></xs:annotation></xs:element><xs:element minOccurs="0" name="BeforeDataSubmit" type="EventType"/><xs:element minOccurs="0" name="BeforeCloseForm" type="EventType"/><xs:element minOccurs="0" name="OnEvent" maxOccurs="unbounded" type="OnEventType"><xs:annotation><xs:documentation>Generic event handler - eventName must be specified.</xs:documentation></xs:annotation></xs:element><xs:element name="Header" type="SectionItemType" minOccurs="0" maxOccurs="1"><xs:annotation><xs:documentation>Optional Section that stays at the top of a form.</xs:documentation></xs:annotation></xs:element><xs:element name="Body" type="SectionItemType" maxOccurs="1"><xs:annotation><xs:documentation>Main Section of form</xs:documentation></xs:annotation></xs:element><xs:element name="Footer" type="SectionItemType" minOccurs="0" maxOccurs="1"><xs:annotation><xs:documentation>Optional Section that stays at the bottom of a form.</xs:documentation></xs:annotation></xs:element><xs:element minOccurs="0" name="Rules" type="RulesType"></xs:element></xs:sequence><xs:attribute name="formTitle" type="xs:string"><xs:annotation><xs:documentation>NEW: human readable title for display when choosing forms. Added 4/27/16</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="filename" type="xs:string"><xs:annotation><xs:documentation>NEW: filename to use when the current FormDesign instance is saved as a file. For forms containing responses, the filename may include the formInstanceVersionURI, but the naming convention may be use-case-specific.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="basedOnURI" type="URI_Atype"><xs:annotation><xs:documentation>NEW: URI used to identify the form that that this FormDesign is based upon. In most cases, this should be a standard form that is modified and/or extended by the current FormDesign. The current template reuses the basedOn IDs whenever the question/answer/semantic context is identical to the original. 5/11/17: Relying on data element mapping may be a better and more flexible approach than @basedOnURI. In this way, forms could compare data elements to determine if they contain semantic matches, and this is supported better with a more robust code map section.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="lineage" type="xs:string" use="required"><xs:annotation><xs:documentation>NEW: A text identifier that is used to group multiple versions of a single form. The lineage is constant for all versions of a single kind of form. When appended to @baseURI, it can be used to retrieve all versions of one particular form.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="version" type="xs:string" use="required"><xs:annotation><xs:documentation>NEW: @version contains the version text for the current form. It is designed to be used in conjuction with @baseURI and @lineage.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="fullURI" type="URI_Atype" use="required"><xs:annotation><xs:documentation>NEW: The full URI that uniquely identifies the current form. It is created by concatenating @baseURI + lineage + version. Each of the componenets is separated by a single forward slash.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="prevVersionURI" type="URI_Atype"><xs:annotation><xs:documentation>NEW: The full URI used to identify the form that is the immediate previous version of the current FormDesign</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="formInstanceURI" type="URI_Atype"><xs:annotation><xs:documentation>NEW: Unique URI used to identify a unique instance of a form. Used for tracking form responses across time and across multiple episodes of editing by end-users. This URI does not change for each edit session of a form instance.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="formInstanceVersionURI" type="URI_Atype"><xs:annotation><xs:documentation>NEW: Unique URI used to identify a unique instance of a form's saved responses. It is used for tracking form responses across time and across multiple episodes of editing by end-users. This URI must change for each edit/save session of a form instance. It may be e.g., a new GUID, or a repeat of the formInstanceID followed by a version number.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="formPreviousInstanceVersionURI" type="URI_Atype"><xs:annotation><xs:documentation>NEW: Unique URI used to identify the immediate previous instance of a form containing responses. This is the @formInstanceVersionURI that represents the instance of the form that the user opened up before beginning a new cycle of edit/save. This attribute is used for tracking form responses across time and across multiple episodes of editing by end-users. This URI must change for each edit session of a form instance.</xs:documentation></xs:annotation></xs:attribute><xs:attributeGroup ref="ResponseAttributes"/></xs:extension></xs:complexContent></xs:complexType>
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Optional message that appears when the rule evaluates to true
Source
<xs:complexType name="ConditionalGroupActionType"><xs:annotation><xs:documentation>Execute an Action based when the Boolean condition returns true. Boolean sub-Conditions and sub-Actions may be nested to any level.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="FuncBoolBaseType"><xs:choice><xs:element name="Conditions" minOccurs="0" type="ConditionsSubActionsType"></xs:element><xs:element name="Actions" minOccurs="0" type="ActionsType"></xs:element></xs:choice></xs:extension></xs:complexContent></xs:complexType>
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
This Rule evaluates an arbitrary set of attribute values from any item and returns a Boolean summary value.In the PropertyValues condition, the contained Boolean attributed values are ANDed together (by default) to return a derived Boolean value. Default values are used if the attribute is not explicitly set to a value. For attributes without default values, omitted (null) values are ignored and are not used for null propagation.
Applies only to items that have Response Fields (Questions and ListItems). If the ListItem or Question has a Response Field, and that field has a value in it, this property returns true. If it does not have a value, it returns false. If no Response Field is present, it retuns null and is not used for Boolean comparisons.
Applies only to Questions that have selection lists (ListItems or LookupField). Evaluates to true if the number of selected items equals the entered value.
Applies only to Questions that have selection lists (ListItems or LookupField). Evaluates to true if the number of selected items equals or exceeds the entered value.
Applies only to Questions that have selection lists (ListItems or LookupField). Evaluates to true if the number of selected items is less than or equal to the entered value.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Optional message that appears when the rule evaluates to true
Source
<xs:complexType name="GetItemAttribValuesType"><xs:annotation><xs:documentation>This Rule evaluates an arbitrary set of attribute values from any item and returns a Boolean summary value. In the PropertyValues condition, the contained Boolean attributed values are ANDed together (by default) to return a derived Boolean value. Default values are used if the attribute is not explicitly set to a value. For attributes without default values, omitted (null) values are ignored and are not used for null propagation.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="FuncBoolBaseType"><xs:sequence><xs:element maxOccurs="unbounded" minOccurs="0" name="ScriptBoolFunc" type="ScriptCodeBoolType"/><xs:element maxOccurs="unbounded" minOccurs="0" name="CallBoolFunc" type="CallBoolFuncType"/><xs:element maxOccurs="unbounded" name="Group" type="GetItemAttribValuesType"/></xs:sequence><xs:attributeGroup ref="BoolAttributes"/><xs:attribute name="itemNames" type="xs:NMTOKENS" use="required"><xs:annotation><xs:documentation>Required name(s) of the item(s) (Section, Question, List Item) that contains the item properties used in the other attributes.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="isSelected" type="xs:boolean"/><xs:attribute name="isActive" type="xs:boolean"><xs:annotation><xs:documentation>If visible and enabled are both true, then isActive is true. Otherwise, it is false.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="hasSelectionsGTE" type="xs:nonNegativeInteger"><xs:annotation><xs:documentation>Applies only to Questions that have selection lists (ListItems or LookupField). Evaluates to true if the number of selected items equals or exceeds the entered value.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="hasSelectionsLTE" type="xs:nonNegativeInteger"><xs:annotation><xs:documentation>Applies only to Questions that have selection lists (ListItems or LookupField). Evaluates to true if the number of selected items is less than or equal to the entered value.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="hasSelectionsExact" type="xs:nonNegativeInteger"><xs:annotation><xs:documentation>Applies only to Questions that have selection lists (ListItems or LookupField). Evaluates to true if the number of selected items equals the entered value.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="hasResponse" type="xs:boolean"><xs:annotation><xs:documentation>Applies only to items that have Response Fields (Questions and ListItems). If the ListItem or Question has a Response Field, and that field has a value in it, this property returns true. If it does not have a value, it returns false. If no Response Field is present, it retuns null and is not used for Boolean comparisons.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="isVisible" type="xs:boolean"/><xs:attribute name="isEnabled" type="xs:boolean"/><xs:attribute name="isRequired" type="xs:boolean"><xs:annotation><xs:documentation>If the minCard value is greater than 0, then isRequired = "true" If the minCard = "0" then isRequired = "false"</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="isReadOnly" type="xs:boolean"/><xs:attribute name="hasType" type="xs:NMTOKENS"/><xs:attribute name="hasStyleClass" type="xs:NMTOKENS"/><xs:attribute name="hasValueEQ" type="xs:decimal"/><xs:attribute name="hasValueLT" type="xs:decimal"/><xs:attribute name="hasValueLTE" type="xs:decimal"/><xs:attribute name="hasValueGT" type="xs:decimal"/><xs:attribute name="hasValueGTE" type="xs:decimal"/><xs:attribute name="hasAssociatedValue" type="xs:boolean"><xs:annotation><xs:documentation>Applies only to ListItems. If the attribute has a value in it, this property returns true. If it does not have a value, it returns false.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="hasAssociatedValueEQ" type="xs:decimal"/><xs:attribute name="hasAssociatedValueLT" type="xs:decimal"/><xs:attribute name="hasAssociatedValueLTE" type="xs:decimal"/><xs:attribute name="hasAssociatedValueGT" type="xs:decimal"/><xs:attribute name="hasAssociatedValueGTE" type="xs:decimal"/><xs:attribute name="supportdatesandIntervals"/></xs:extension></xs:complexContent></xs:complexType>
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:complexType name="ActionsType"><xs:complexContent><xs:extension base="ExtensionBaseType"><xs:choice maxOccurs="unbounded"><xs:annotation><xs:documentation>Then action choices and nested conditional statements</xs:documentation></xs:annotation><xs:element name="Action" type="ActActionType"><xs:annotation><xs:documentation>A generic ExtensionBaseType for custom actions in a "Then" section.</xs:documentation></xs:annotation></xs:element><xs:element name="SetProperty" type="ActSetItemAttributeType"/><xs:element name="AddCode" type="ActAddCodeType"/><xs:element name="Inject" type="ActInjectType"/><xs:element name="ShowURL" type="CallFuncType"/><xs:element name="Save" type="ActSaveResponsesType"/><xs:element name="SendReport" type="ActSendReportType"/><xs:element name="SendMessage111" type="ActSendMessageType"/><xs:element name="SetItemAttributeValue" type="ActSetItemAttributeType"/><xs:element name="SetAttributeValue" type="ActSetAttrValueType"/><xs:element name="SetBoolValue" type="ActSetValueBoolType"/><xs:element name="ShowForm" type="ActShowFormType"/><xs:element name="ShowMessage" type="ActShowMessageType"/><xs:element name="ShowReport" type="ActShowReportType"/><xs:element name="PreviewReport" type="ActPreviewReportType"/><xs:element name="ValidateForm" type="ActValidateFormType"/><xs:element name="RunCode" type="ScriptCodeAnyType"/><xs:element name="CallCode" type="CallFuncType"><xs:annotation><xs:documentation>Execute a local rule located elsewhere in the FormDesign template. Use the @name value in @val property of Function</xs:documentation></xs:annotation></xs:element><xs:element name="ConditionalGroupAction" type="ConditionalGroupActionType"/></xs:choice></xs:extension></xs:complexContent></xs:complexType>
Complex Type ActActionType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
Add a custom action, not defined in the basic SDC Schemas.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:complexType name="ActActionType"><xs:annotation><xs:documentation>Add a custom action, not defined in the basic SDC Schemas.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="ExtensionBaseType"><xs:choice maxOccurs="unbounded" minOccurs="0"><xs:element maxOccurs="unbounded" minOccurs="0" name="Parameter" type="ParameterItemType"/><xs:element minOccurs="0" name="ParameterValue" type="ParameterValueType" maxOccurs="unbounded"/></xs:choice><xs:attribute name="action" type="xs:string" use="required"/></xs:extension></xs:complexContent></xs:complexType>
Complex Type ActSetItemAttributeType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
This type is used to act upon the value of common item attributes. If an "act" attribute (a type with the "act" prefix) has no value assigned, it is ignored. If it has a value, then that attribute on the target item(s) assume(s) that stated value when an attached Boolean condition evaluates to true. The attached condition may be an "If" statement or any expression that evaluates to a Boolean value.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:complexType name="ActSetItemAttributeType"><xs:annotation><xs:documentation>This type is used to act upon the value of common item attributes. If an "act" attribute (a type with the "act" prefix) has no value assigned, it is ignored. If it has a value, then that attribute on the target item(s) assume(s) that stated value when an attached Boolean condition evaluates to true. The attached condition may be an "If" statement or any expression that evaluates to a Boolean value.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="ExtensionBaseType"><xs:attribute name="targetNames" type="xs:NMTOKENS" use="required"><xs:annotation><xs:documentation>The names of the items affected by property actions</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="actVisible" type="xs:boolean"/><xs:attribute name="actEnable" type="xs:boolean"/><xs:attribute name="actMinCard" type="xs:nonNegativeInteger"><xs:annotation><xs:documentation>Controls requirement to answer the question and the minimum number of repeats.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="actMaxCard" type="xs:nonNegativeInteger"><xs:annotation><xs:documentation>Controls requirement to answer the question</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="actActivate" type="xs:boolean"><xs:annotation><xs:documentation>Toggle visible and enabled together. Setting this to false will de-activate all descendents but will not change their enabled or visible properties.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="actSelect" type="xs:boolean"><xs:annotation><xs:documentation>Toggle selection of a List Item; not applicable to other items.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="actDeleteResponse" type="xs:boolean"><xs:annotation><xs:documentation>Delete any response in a Response field on a question or ListItem. Not applicable to other item types.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="actReadOnly" type="xs:boolean"><xs:annotation><xs:documentation>Delete any response in a Response field on a question or ListItem. Not applicable to other item types.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="actType" type="xs:NMTOKENS"><xs:annotation><xs:documentation>Set the @type attribute value</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="actStyleClass" type="xs:NMTOKENS"><xs:annotation><xs:documentation>Set the @styleClass attribute value</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="actSetTitleText" type="xs:string"><xs:annotation><xs:documentation>Set the @title text on an item.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="actSetBase64HTML" type="xs:base64Binary"><xs:annotation><xs:documentation>Set HTML as base-64-encoded binary</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="actSetCode" type="xs:string"/><xs:attribute name="actSetCodeSystem" type="xs:string"/><xs:attribute name="actSetVal" type="xs:string"><xs:annotation><xs:documentation>Set a @val attribute. The correct data type must be used if applicable.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="actSetAssociatedValue" type="xs:string"><xs:annotation><xs:documentation>Set @associatedValue attribute of a ListItem. The correct data type must be used if applicable.</xs:documentation></xs:annotation></xs:attribute></xs:extension></xs:complexContent></xs:complexType>
Complex Type ActAddCodeType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
Add all or part of a coding section to the designated target site.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:complexType name="ActAddCodeType"><xs:annotation><xs:documentation>Add all or part of a coding section to the designated target site.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="ItemNameType"><xs:sequence><xs:element name="Code" type="CodingType"/></xs:sequence></xs:extension></xs:complexContent></xs:complexType>
Complex Type ActInjectType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
Inject a form or part of a form at the specified location. The injected section may come from the current form.
If the ID does not use the default base URI (namespace), then the local baseURI goes here. Note that all IDs must be unique within a form, even if they do not have the same baseURI. Ideally, the baseURI + ID should combine to form a *globally* unique identifier, that uniquely identifies an item in a particular form. The same baseURI and ID may be reused in derived or versioned forms, as long as the context stays the same, and any affected data elements remain unchanged in context and semantics. Following this approach is likely to simplify analytics based on form content.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
DRAFT: The baseURI of the package, whihc indicates the home source of the package. The formManagerURP + pkgBaseURI + pkgID are concatenated to retrieve an empty form. formManagerURP + pkgBaseURI + pkgInstanceVersionURI are concatenated to retrieve a specific version of a populated form. formManagerURP + pkgBaseURI + pkgInstanceURI are concatenated to retrieve the latest instance of a populated form.
NEW: Unique URI used to identify a unique instance of a package. Used for tracking form responses across time and across multiple episodes of editing by end-users. This URI does not change for each edit session of a package instance.
NEW: Unique URI used to identify a unique instance of a package's saved responses. It is used for tracking package responses across time and across multiple episodes of editing by end-users. This URI must change for each edit/save session of a package instance. It may be e.g., a new GUID, or a repeat of the pkgInstanceID followed by a version number.
The rootItemID is the ID of the form part that will be injected. If empty, then the entre form should be injected as the FormDesign element node. If not empty, it must point to a valid Section or Question.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:complexType name="ActInjectType"><xs:annotation><xs:documentation>Inject a form or part of a form at the specified location. The injected section may come from the current form.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="InjectFormType"><xs:attribute name="targetNames" type="xs:NMTOKENS"><xs:annotation><xs:documentation>The names of the parent items that will have the form (or form section) injected as child node(s).</xs:documentation></xs:annotation></xs:attribute></xs:extension></xs:complexContent></xs:complexType>
Complex Type InjectFormType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
CHANGED:This type represents a form or portion of a form that is imported into the current form at a specific location. It allows the composition of forms from other forms or parts of other forms.In practice, using an injected section will requiresome or all of the injected FormDesignXML to be injected under this the InjectForm element. For that reason, the schema supports those elements to appear inline. However, in a "raw" form (not yet filled out), the FormDesign element would generally be empty; only the top-level InjectFormType attributes would be used to point to the parts to be later injected.Form parts to be injected are specified by packageID, not FormID. This allows an injected form to be assocaited with helper files, or to return previosuly completed form parts containing responses.
If the ID does not use the default base URI (namespace), then the local baseURI goes here. Note that all IDs must be unique within a form, even if they do not have the same baseURI. Ideally, the baseURI + ID should combine to form a *globally* unique identifier, that uniquely identifies an item in a particular form. The same baseURI and ID may be reused in derived or versioned forms, as long as the context stays the same, and any affected data elements remain unchanged in context and semantics. Following this approach is likely to simplify analytics based on form content.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
DRAFT: The baseURI of the package, whihc indicates the home source of the package. The formManagerURP + pkgBaseURI + pkgID are concatenated to retrieve an empty form. formManagerURP + pkgBaseURI + pkgInstanceVersionURI are concatenated to retrieve a specific version of a populated form. formManagerURP + pkgBaseURI + pkgInstanceURI are concatenated to retrieve the latest instance of a populated form.
NEW: Unique URI used to identify a unique instance of a package. Used for tracking form responses across time and across multiple episodes of editing by end-users. This URI does not change for each edit session of a package instance.
NEW: Unique URI used to identify a unique instance of a package's saved responses. It is used for tracking package responses across time and across multiple episodes of editing by end-users. This URI must change for each edit/save session of a package instance. It may be e.g., a new GUID, or a repeat of the pkgInstanceID followed by a version number.
The rootItemID is the ID of the form part that will be injected. If empty, then the entre form should be injected as the FormDesign element node. If not empty, it must point to a valid Section or Question.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:complexType name="InjectFormType"><xs:annotation><xs:documentation>CHANGED: This type represents a form or portion of a form that is imported into the current form at a specific location. It allows the composition of forms from other forms or parts of other forms. In practice, using an injected section will requiresome or all of the injected FormDesignXML to be injected under this the InjectForm element. For that reason, the schema supports those elements to appear inline. However, in a "raw" form (not yet filled out), the FormDesign element would generally be empty; only the top-level InjectFormType attributes would be used to point to the parts to be later injected. Form parts to be injected are specified by packageID, not FormID. This allows an injected form to be assocaited with helper files, or to return previosuly completed form parts containing responses.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="IdentifiedExtensionType"><xs:choice minOccurs="0"><xs:element name="Section" type="SectionItemType"/><xs:element name="Question" type="QuestionItemType"/><xs:element name="FormDesign" type="FormDesignType"/></xs:choice><xs:attribute name="pkgID" type="URI_Atype"><xs:annotation><xs:documentation>This ID represents the Package that contains the form to be injected. The package may contain an empty form or a form containing responses.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="pkgInstanceURI" type="URI_Atype"><xs:annotation><xs:documentation>NEW: Unique URI used to identify a unique instance of a package. Used for tracking form responses across time and across multiple episodes of editing by end-users. This URI does not change for each edit session of a package instance.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="pkgInstanceVersionURI" type="URI_Atype"><xs:annotation><xs:documentation>NEW: Unique URI used to identify a unique instance of a package's saved responses. It is used for tracking package responses across time and across multiple episodes of editing by end-users. This URI must change for each edit/save session of a package instance. It may be e.g., a new GUID, or a repeat of the pkgInstanceID followed by a version number.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="pkgBaseURI" type="URI_Atype"><xs:annotation><xs:documentation>DRAFT: The baseURI of the package, whihc indicates the home source of the package. The formManagerURP + pkgBaseURI + pkgID are concatenated to retrieve an empty form. formManagerURP + pkgBaseURI + pkgInstanceVersionURI are concatenated to retrieve a specific version of a populated form. formManagerURP + pkgBaseURI + pkgInstanceURI are concatenated to retrieve the latest instance of a populated form.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="pkgFullURI" type="URI_Atype"><xs:annotation><xs:documentation>DRAFT: The injected package is retrieved form formManagerURI + "/" + pkgFullURI</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="pkgManagerURI" type="URI_Atype"><xs:annotation><xs:documentation>The server from which the injected package will be retrieved.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="rootItemID" type="URI_Atype"><xs:annotation><xs:documentation>The rootItemID is the ID of the form part that will be injected. If empty, then the entre form should be injected as the FormDesign element node. If not empty, it must point to a valid Section or Question.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="X_injectionID" type="xs:string"><xs:annotation><xs:documentation>Unique ID (GUID) to distinguish multiple instances of the same injected node.</xs:documentation></xs:annotation></xs:attribute></xs:extension></xs:complexContent></xs:complexType>
Complex Type SectionItemType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
The Section is a grouper for all other types of objects. It may have a distinctive visual display (e.g. a box containing other displayed objects), and it may be used to treat Section descendants as a unit for special handling, such as hiding and showing.
If the ID does not use the default base URI (namespace), then the local baseURI goes here. Note that all IDs must be unique within a form, even if they do not have the same baseURI. Ideally, the baseURI + ID should combine to form a *globally* unique identifier, that uniquely identifies an item in a particular form. The same baseURI and ID may be reused in derived or versioned forms, as long as the context stays the same, and any affected data elements remain unchanged in context and semantics. Following this approach is likely to simplify analytics based on form content.
A globally unique string assigned to a repeating Question or Section, Injected Form, or any selected answer ListItem. This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among sections or questions, including those that are allowed to repeat and nest deeply.
@maxCard is the maximum number of repetitions allowed for a section or question. The default value is 1, indicating that the section or question cannot be repeated on the data entry form. A value of 0 indicates that the number of repeats is unlimited. If @maxCard is not 0, then Must be greater than or equal to minCard.
@minCard is the minimum number of repetitions allowed for a section or question. The default value is 1, indicating that the user must answer any question(s) that has this attribute set. If @minCard is set to 0, then the item and all descendent questions are optional to answer.
If this attribute is set to "true" (the default), then the form implementation must make this item available for use on the form. If this attribute is set to "false" on a parent or ancestor item, then all child/descendant items inherit this "false" setting, even if they have this attribute set to "true." In other words, the child/descendent items do not need to be implemented if any parent/ancestor item has this attribute set to false.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
A globally unique string assigned from a Section, Question, ListItem or InjectedForm to the ID of its parent node (S, Q, LI or IF). This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among the above objects, including those that are allowed to repeat and nest deeply.
Allows the form filler to specify whether the current response is the initial response, or records the type of change made since the initial response was reported.
CHANGED to T/F/OptionalIf @showInReport on a Question is false, then the Question and its ListItems (if any) should not be present in a typical report derived from this template. If this attribute appears on a ListItem, then the entire question and all ListItems should be omitted from the report. If this attribute appears on a Section, then the entire Section and all Section contents (descendents) should be omitted from the report. If @showInReport appears on a DisplayedItem, then the DisplayedItem (and all sub-items) should be omitted from the report.This attribute is usually set to false when a Question is used to control form behavior (e.g., skip logic), or when the Question provides unhelpful "negative" information about actions that did not occur or were not performed, or things that were not observed.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Determines whether the item should be visible on a computer screen when the form is first displayed.
Source
<xs:complexType name="SectionItemType"><xs:annotation><xs:documentation>The Section is a grouper for all other types of objects. It may have a distinctive visual display (e.g. a box containing other displayed objects), and it may be used to treat Section descendants as a unit for special handling, such as hiding and showing.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="SectionBaseType"><xs:choice minOccurs="0"><xs:annotation><xs:documentation>MainNodes choices</xs:documentation></xs:annotation><xs:element name="ChildItems" type="ChildItemsType" minOccurs="0"><xs:annotation><xs:documentation>Child items are of type DisplayedType. They may include items of type SectionType, QuestionType, InjectFormType, DisplayedType and ButtonType, in any order.</xs:documentation></xs:annotation></xs:element></xs:choice></xs:extension></xs:complexContent></xs:complexType>
Complex Type SectionBaseType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
This base item is the same as the SectionItemType, except it lacks the recursion created by the inclusion of MainItems sub-group.
If the ID does not use the default base URI (namespace), then the local baseURI goes here. Note that all IDs must be unique within a form, even if they do not have the same baseURI. Ideally, the baseURI + ID should combine to form a *globally* unique identifier, that uniquely identifies an item in a particular form. The same baseURI and ID may be reused in derived or versioned forms, as long as the context stays the same, and any affected data elements remain unchanged in context and semantics. Following this approach is likely to simplify analytics based on form content.
A globally unique string assigned to a repeating Question or Section, Injected Form, or any selected answer ListItem. This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among sections or questions, including those that are allowed to repeat and nest deeply.
@maxCard is the maximum number of repetitions allowed for a section or question. The default value is 1, indicating that the section or question cannot be repeated on the data entry form. A value of 0 indicates that the number of repeats is unlimited. If @maxCard is not 0, then Must be greater than or equal to minCard.
@minCard is the minimum number of repetitions allowed for a section or question. The default value is 1, indicating that the user must answer any question(s) that has this attribute set. If @minCard is set to 0, then the item and all descendent questions are optional to answer.
If this attribute is set to "true" (the default), then the form implementation must make this item available for use on the form. If this attribute is set to "false" on a parent or ancestor item, then all child/descendant items inherit this "false" setting, even if they have this attribute set to "true." In other words, the child/descendent items do not need to be implemented if any parent/ancestor item has this attribute set to false.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
A globally unique string assigned from a Section, Question, ListItem or InjectedForm to the ID of its parent node (S, Q, LI or IF). This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among the above objects, including those that are allowed to repeat and nest deeply.
Allows the form filler to specify whether the current response is the initial response, or records the type of change made since the initial response was reported.
CHANGED to T/F/OptionalIf @showInReport on a Question is false, then the Question and its ListItems (if any) should not be present in a typical report derived from this template. If this attribute appears on a ListItem, then the entire question and all ListItems should be omitted from the report. If this attribute appears on a Section, then the entire Section and all Section contents (descendents) should be omitted from the report. If @showInReport appears on a DisplayedItem, then the DisplayedItem (and all sub-items) should be omitted from the report.This attribute is usually set to false when a Question is used to control form behavior (e.g., skip logic), or when the Question provides unhelpful "negative" information about actions that did not occur or were not performed, or things that were not observed.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Determines whether the item should be visible on a computer screen when the form is first displayed.
Source
<xs:complexType name="SectionBaseType" abstract="true"><xs:annotation><xs:documentation>This base item is the same as the SectionItemType, except it lacks the recursion created by the inclusion of MainItems sub-group.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="RepeatingType"><xs:attribute default="true" name="ordered" type="xs:boolean"><xs:annotation><xs:documentation>If false, then the form implementation may change the order of items in the section.</xs:documentation></xs:annotation></xs:attribute><xs:attributeGroup ref="ResponseAttributes"/></xs:extension></xs:complexContent></xs:complexType>
Complex Type RepeatingType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
This type presents any display objects that may be repeated based upon on the user's interaction with the form objects. Items derived from this type include Sections and Questions.
If the ID does not use the default base URI (namespace), then the local baseURI goes here. Note that all IDs must be unique within a form, even if they do not have the same baseURI. Ideally, the baseURI + ID should combine to form a *globally* unique identifier, that uniquely identifies an item in a particular form. The same baseURI and ID may be reused in derived or versioned forms, as long as the context stays the same, and any affected data elements remain unchanged in context and semantics. Following this approach is likely to simplify analytics based on form content.
A globally unique string assigned to a repeating Question or Section, Injected Form, or any selected answer ListItem. This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among sections or questions, including those that are allowed to repeat and nest deeply.
@maxCard is the maximum number of repetitions allowed for a section or question. The default value is 1, indicating that the section or question cannot be repeated on the data entry form. A value of 0 indicates that the number of repeats is unlimited. If @maxCard is not 0, then Must be greater than or equal to minCard.
@minCard is the minimum number of repetitions allowed for a section or question. The default value is 1, indicating that the user must answer any question(s) that has this attribute set. If @minCard is set to 0, then the item and all descendent questions are optional to answer.
If this attribute is set to "true" (the default), then the form implementation must make this item available for use on the form. If this attribute is set to "false" on a parent or ancestor item, then all child/descendant items inherit this "false" setting, even if they have this attribute set to "true." In other words, the child/descendent items do not need to be implemented if any parent/ancestor item has this attribute set to false.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
A globally unique string assigned from a Section, Question, ListItem or InjectedForm to the ID of its parent node (S, Q, LI or IF). This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among the above objects, including those that are allowed to repeat and nest deeply.
CHANGED to T/F/OptionalIf @showInReport on a Question is false, then the Question and its ListItems (if any) should not be present in a typical report derived from this template. If this attribute appears on a ListItem, then the entire question and all ListItems should be omitted from the report. If this attribute appears on a Section, then the entire Section and all Section contents (descendents) should be omitted from the report. If @showInReport appears on a DisplayedItem, then the DisplayedItem (and all sub-items) should be omitted from the report.This attribute is usually set to false when a Question is used to control form behavior (e.g., skip logic), or when the Question provides unhelpful "negative" information about actions that did not occur or were not performed, or things that were not observed.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Determines whether the item should be visible on a computer screen when the form is first displayed.
Source
<xs:complexType name="RepeatingType" abstract="true"><xs:annotation><xs:documentation>This type presents any display objects that may be repeated based upon on the user's interaction with the form objects. Items derived from this type include Sections and Questions.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="DisplayedType"><xs:attribute name="minCard" type="xs:unsignedShort" default="1"><xs:annotation><xs:documentation>@minCard is the minimum number of repetitions allowed for a section or question. The default value is 1, indicating that the user must answer any question(s) that has this attribute set. If @minCard is set to 0, then the item and all descendent questions are optional to answer.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="maxCard" default="1" type="xs:unsignedShort"><xs:annotation><xs:documentation>@maxCard is the maximum number of repetitions allowed for a section or question. The default value is 1, indicating that the section or question cannot be repeated on the data entry form. A value of 0 indicates that the number of repeats is unlimited. If @maxCard is not 0, then Must be greater than or equal to minCard.</xs:documentation></xs:annotation></xs:attribute><xs:attributeGroup ref="ResponseReportingAttributes"/></xs:extension></xs:complexContent></xs:complexType>
Complex Type DisplayedType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
This type represents any object that is designed to have a visual presence on a form, e.g., Sections, Questions, ListItems, Notes and Blobs. (Other items not inheriting this type may use an optional styleClass attribute.)
If the ID does not use the default base URI (namespace), then the local baseURI goes here. Note that all IDs must be unique within a form, even if they do not have the same baseURI. Ideally, the baseURI + ID should combine to form a *globally* unique identifier, that uniquely identifies an item in a particular form. The same baseURI and ID may be reused in derived or versioned forms, as long as the context stays the same, and any affected data elements remain unchanged in context and semantics. Following this approach is likely to simplify analytics based on form content.
If this attribute is set to "true" (the default), then the form implementation must make this item available for use on the form. If this attribute is set to "false" on a parent or ancestor item, then all child/descendant items inherit this "false" setting, even if they have this attribute set to "true." In other words, the child/descendent items do not need to be implemented if any parent/ancestor item has this attribute set to false.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
CHANGED to T/F/OptionalIf @showInReport on a Question is false, then the Question and its ListItems (if any) should not be present in a typical report derived from this template. If this attribute appears on a ListItem, then the entire question and all ListItems should be omitted from the report. If this attribute appears on a Section, then the entire Section and all Section contents (descendents) should be omitted from the report. If @showInReport appears on a DisplayedItem, then the DisplayedItem (and all sub-items) should be omitted from the report.This attribute is usually set to false when a Question is used to control form behavior (e.g., skip logic), or when the Question provides unhelpful "negative" information about actions that did not occur or were not performed, or things that were not observed.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Determines whether the item should be visible on a computer screen when the form is first displayed.
Source
<xs:complexType name="DisplayedType"><xs:annotation><xs:documentation>This type represents any object that is designed to have a visual presence on a form, e.g., Sections, Questions, ListItems, Notes and Blobs. (Other items not inheriting this type may use an optional styleClass attribute.)</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="IdentifiedExtensionType"><xs:sequence><xs:element maxOccurs="unbounded" minOccurs="0" name="Link" type="LinkType"><xs:annotation><xs:documentation>Link to external information.</xs:documentation></xs:annotation></xs:element><xs:element name="BlobContent" type="BlobType" minOccurs="0" maxOccurs="unbounded"><xs:annotation><xs:documentation>Blob information associated with the current DisplayedType. The blob may contain any type of special media, but must be base 64 encoded.</xs:documentation></xs:annotation></xs:element><xs:element maxOccurs="unbounded" name="Contact" type="ContactType" minOccurs="0"><xs:annotation><xs:documentation>Any desired contact information regarding, e.g., the form item, authoring process, certifications, code or coding processs.</xs:documentation></xs:annotation></xs:element><xs:element maxOccurs="unbounded" minOccurs="0" name="CodedValue" type="CodingType"><xs:annotation><xs:documentation>Coding, terminology, classification, keyword, or local values</xs:documentation></xs:annotation></xs:element><xs:element minOccurs="0" name="OnEnter" type="EventType" maxOccurs="unbounded"/><xs:element minOccurs="0" name="OnExit" type="EventType" maxOccurs="unbounded"/><xs:element minOccurs="0" name="OnEvent" maxOccurs="unbounded" type="OnEventType"><xs:annotation><xs:documentation>Generic event handler - eventName must be specified.</xs:documentation></xs:annotation></xs:element><xs:element minOccurs="0" name="ActivateIf" type="GuardType"><xs:annotation><xs:documentation>Activate the DisplayedType item if the guard conditions are met.</xs:documentation></xs:annotation></xs:element><xs:element minOccurs="0" name="DeActivateIf" type="GuardType"><xs:annotation><xs:documentation>DeActivate the DisplayedType item if the guard conditions are met.</xs:documentation></xs:annotation></xs:element></xs:sequence><xs:attribute name="title" type="xs:string"><xs:annotation><xs:documentation>The primary text to show on the form. Also known as "prompt" or "label" or "visibleText" or "caption"</xs:documentation></xs:annotation></xs:attribute><xs:attribute default="true" name="enabled" type="xs:boolean"><xs:annotation><xs:documentation>Determines whether the user can interact with the displayed item when the form is first displayed.</xs:documentation></xs:annotation></xs:attribute><xs:attribute default="true" name="visible" type="xs:boolean"><xs:annotation><xs:documentation>Determines whether the item should be visible on a computer screen when the form is first displayed.</xs:documentation></xs:annotation></xs:attribute><xs:attribute default="true" name="mustImplement" type="xs:boolean"><xs:annotation><xs:documentation>If this attribute is set to "true" (the default), then the form implementation must make this item available for use on the form. If this attribute is set to "false" on a parent or ancestor item, then all child/descendant items inherit this "false" setting, even if they have this attribute set to "true." In other words, the child/descendent items do not need to be implemented if any parent/ancestor item has this attribute set to false.</xs:documentation></xs:annotation></xs:attribute><xs:attribute default="True" name="showInReport"><xs:annotation><xs:documentation>CHANGED to T/F/Optional If @showInReport on a Question is false, then the Question and its ListItems (if any) should not be present in a typical report derived from this template. If this attribute appears on a ListItem, then the entire question and all ListItems should be omitted from the report. If this attribute appears on a Section, then the entire Section and all Section contents (descendents) should be omitted from the report. If @showInReport appears on a DisplayedItem, then the DisplayedItem (and all sub-items) should be omitted from the report. This attribute is usually set to false when a Question is used to control form behavior (e.g., skip logic), or when the Question provides unhelpful "negative" information about actions that did not occur or were not performed, or things that were not observed.</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:string"><xs:enumeration value="True"/><xs:enumeration value="False"/><xs:enumeration value="Optional"/></xs:restriction></xs:simpleType></xs:attribute></xs:extension></xs:complexContent></xs:complexType>
Complex Type ActSaveResponsesType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
Save the form's responses to the default persistance layer(s). The default format is SDCSubmitForm, but other formats may be defined and used.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:complexType name="ActSaveResponsesType"><xs:annotation><xs:documentation>Save the form's responses to the default persistance layer(s). The default format is SDCSubmitForm, but other formats may be defined and used.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="ExtensionBaseType"><xs:sequence><xs:element name="MessageText" type="RichTextType"/></xs:sequence></xs:extension></xs:complexContent></xs:complexType>
Complex Type ActSendReportType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
Send a report to an endpoint, via email, fax or web service. The default report will be transmittted in SDCSubmitForm format, but may adopt a custom report type
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:complexType name="ActSendReportType"><xs:annotation><xs:documentation>Send a report to an endpoint, via email, fax or web service. The default report will be transmittted in SDCSubmitForm format, but may adopt a custom report type</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="ExtensionBaseType"><xs:choice maxOccurs="unbounded"><xs:element name="Email" type="EmailAddressType"/><xs:element name="Fax" type="PhoneNumberType"/><xs:element name="WebService" type="CallFuncType"/></xs:choice><xs:attribute name="reportID" type="URI_Atype"/><xs:attribute name="reportInstanceGuid" type="xs:string"/><xs:attribute name="reportInstanceVersonGuid" type="xs:string"/></xs:extension></xs:complexContent></xs:complexType>
Complex Type ActSendMessageType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
Send a message to any endpoint. Messages may include alerts of various types. The default datatype for messages is string.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
<xs:complexType name="ActSendMessageType"><xs:annotation><xs:documentation>Send a message to any endpoint. Messages may include alerts of various types. The default datatype for messages is string.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="RichTextType"><xs:choice><xs:element name="Email" type="EmailAddressType" maxOccurs="unbounded"/><xs:element name="Fax" type="PhoneNumberType" maxOccurs="unbounded"/><xs:element name="WebService" type="CallFuncType" maxOccurs="unbounded"/></xs:choice><xs:attribute name="messageType" type="xs:string"/></xs:extension></xs:complexContent></xs:complexType>
Complex Type ActSetAttrValueType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
This type is used to act upon the value of common item properties. If an "act" property (a property with the "act" prefix) has no value assigned, it is ignored. If it has a value, then that property on the target item(s) assume(s) that stated value when an attached Boolean condition evaluates to true. The attached condition may be an "If" statement or any expression that evaluates to a Boolean value.
Defines the data type held by a string value.Also defines the dataType for list items in a list, which uses the generic string type, since string can represent any XML data type. List items of any data type should be validated by the implementation software, since all data types are written into an XML list of type string.For typed items included by reference to an external (reference or variable) value, use short name strings preceded by "$".
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:complexType name="ActSetAttrValueType"><xs:annotation><xs:documentation>This type is used to act upon the value of common item properties. If an "act" property (a property with the "act" prefix) has no value assigned, it is ignored. If it has a value, then that property on the target item(s) assume(s) that stated value when an attached Boolean condition evaluates to true. The attached condition may be an "If" statement or any expression that evaluates to a Boolean value.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="ScriptCodeAnyType"><xs:sequence><xs:element name="Target" type="ItemNameAttributeType"/></xs:sequence></xs:extension></xs:complexContent></xs:complexType>
Complex Type ActSetValueBoolType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
Sets the value of any named attribute. However, it is primarily designed for Response element(s) on a Question or ListItem. The value may be determined by a literal value with a defined data type, the value at another named Response item, an expression written in a specified scripting or programming language, or the value of a named code listed in the same template.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Optional message that appears when the rule evaluates to true
Source
<xs:complexType name="ActSetValueBoolType"><xs:annotation><xs:documentation>Sets the value of any named attribute. However, it is primarily designed for Response element(s) on a Question or ListItem. The value may be determined by a literal value with a defined data type, the value at another named Response item, an expression written in a specified scripting or programming language, or the value of a named code listed in the same template.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="ScriptCodeBoolType"><xs:attribute name="elementName" type="xs:NCName" use="required"><xs:annotation><xs:documentation>The @name attribute of the referenced element.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="attributeName" type="xs:NCName" default="val"><xs:annotation><xs:documentation>The name of any attribute on a named element.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="X_targetNames" type="xs:NMTOKENS" use="required"/></xs:extension></xs:complexContent></xs:complexType>
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:complexType name="ActShowFormType"><xs:annotation><xs:documentation>Show an external form to interact with the user.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="ExtensionBaseType"><xs:attribute name="formID" type="URI_Atype"><xs:annotation><xs:documentation>This ID represents the form to be displayed.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="packageID" type="URI_Atype" use="required"><xs:annotation><xs:documentation>This ID represents the Package that contains the form to be displayed.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="displayState" type="xs:string"/></xs:extension></xs:complexContent></xs:complexType>
Complex Type ActShowMessageType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
Display a message to the form user, triggered by activity within the form.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:complexType name="ActShowMessageType"><xs:annotation><xs:documentation>Display a message to the form user, triggered by activity within the form.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="ExtensionBaseType"><xs:sequence><xs:element maxOccurs="unbounded" name="Message" type="RichTextType"></xs:element></xs:sequence><xs:attribute name="alertLevel" type="xs:string"/><xs:attribute name="alertType" type="xs:string"/><xs:attribute name="messageType" type="xs:string"/><xs:attribute name="messageCode" type="xs:string"/></xs:extension></xs:complexContent></xs:complexType>
Complex Type ActShowReportType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
Show a stored report. The following parameters may be used:reportID: indicator of a report definition in SDC format.packageID: retrieve report as a package with ancillary information.reportInstanceGUID: retreive 1 or more report versions by using a report instance GUID. This may be used in conjunctions with a packageID.reportInstanceVersionGUID: retrieve a single version of a report representing the state of a report when it was saved. This may be used in conjunctions with a packageID.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:complexType name="ActShowReportType"><xs:annotation><xs:documentation>Show a stored report. The following parameters may be used: reportID: indicator of a report definition in SDC format. packageID: retrieve report as a package with ancillary information. reportInstanceGUID: retreive 1 or more report versions by using a report instance GUID. This may be used in conjunctions with a packageID. reportInstanceVersionGUID: retrieve a single version of a report representing the state of a report when it was saved. This may be used in conjunctions with a packageID.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="ExtensionBaseType"><xs:attribute name="reportID" type="URI_Atype"><xs:annotation><xs:documentation>This ID represents the report to be displayed.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="packageID" type="URI_Atype"><xs:annotation><xs:documentation>This ID represents the Package that contains the report to be displayed.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="reportInstanceGuid" type="xs:string"/><xs:attribute name="reportInstanceVersonGuid" type="xs:string"/><xs:attribute name="displayState" type="xs:string"/></xs:extension></xs:complexContent></xs:complexType>
Complex Type ActPreviewReportType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
Show a report preview, based on data in the current form. The following parameter may be used:reportID: points to a report definition in SDC format.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:complexType name="ActPreviewReportType"><xs:annotation><xs:documentation>Show a report preview, based on data in the current form. The following parameter may be used: reportID: points to a report definition in SDC format.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="ExtensionBaseType"><xs:attribute name="reportID" type="URI_Atype"><xs:annotation><xs:documentation>This ID represents the report to be displayed.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="displayState" type="xs:string"/></xs:extension></xs:complexContent></xs:complexType>
Complex Type ActValidateFormType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
Test the data in the form for proper data types, rule integrity, and completeness of required questions.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
<xs:complexType name="ActValidateFormType"><xs:annotation><xs:documentation>Test the data in the form for proper data types, rule integrity, and completeness of required questions.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="ExtensionBaseType"><xs:sequence minOccurs="0"><xs:element minOccurs="0" name="ValidationWebService" type="CallFuncType"/></xs:sequence><xs:attribute default="false" name="validateDataTypes" type="xs:boolean"/><xs:attribute default="false" name="validateRules" type="xs:boolean"/><xs:attribute default="false" name="validateCompleteness" type="xs:boolean"/><xs:attribute name="validationType" type="xs:string"/></xs:extension></xs:complexContent></xs:complexType>
Complex Type OnEventType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
Add a custom event handler to a form item such as a question, section or list item.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Optional message that appears when the rule evaluates to true
Source
<xs:complexType name="OnEventType"><xs:annotation><xs:documentation>Add a custom event handler to a form item such as a question, section or list item.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="EventType"><xs:attribute name="eventName" type="xs:string" use="required"/></xs:extension></xs:complexContent></xs:complexType>
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
This Rule component evaluates the @selected status of any set of ListItems at runtime, and returns a true or false value based on the @selected status of each ListItem.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
This list contains names of ListItems (answer choices) that are watched for being selected or unselected.If a ListItem appears in this list, then it evaluates to true when it is selected. If a ListItem is prefixed with a hyphen (-), then it evaluates to true when unselected. These Boolean values, derived from each named ListItem in the list, are ANDed together (by default) to produce a return value of true or false. The default Boolean operator (AND) may be changed using @boolOp. If @not = true, then the Boolean result is logically negated.Renamed from: ListItemSelections
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Optional message that appears when the rule evaluates to true
Source
<xs:complexType name="MultiSelectionSetBoolType"><xs:annotation><xs:documentation>This Rule component evaluates the @selected status of any set of ListItems at runtime, and returns a true or false value based on the @selected status of each ListItem.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="FuncBoolBaseType"><xs:attributeGroup ref="SelectionDependencyAttributes"/></xs:extension></xs:complexContent></xs:complexType>
Complex Type RuleSelectionTestType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
This Rule specifies a set of ListItems that cannot be selected (@listItemNames) when a test ListItem (@testItemName) is selected. If any selection occurs in @listItemNames when @testItemName is selected, the rule evaluate to true. In all other cases, the rule evaluates to false.Multiple selections in @listItemNames are acceptable as long as @testItemName is unselected, and in this case, the rule evaluates to false."Legal" (allowed) selections evaluate to false"Illegal" selections evaluate to trueThese values can be reversed if @not is set to trueRenamed from: IllegalSelectionTest
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The ListItem that is being evaluated for the presence of disallowed selections (in @listItemNames). This attributes contains the @name of one ListItem.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Optional message that appears when the rule evaluates to true
Source
<xs:complexType name="RuleSelectionTestType"><xs:annotation><xs:documentation>This Rule specifies a set of ListItems that cannot be selected (@listItemNames) when a test ListItem (@testItemName) is selected. If any selection occurs in @listItemNames when @testItemName is selected, the rule evaluate to true. In all other cases, the rule evaluates to false. Multiple selections in @listItemNames are acceptable as long as @testItemName is unselected, and in this case, the rule evaluates to false. "Legal" (allowed) selections evaluate to false "Illegal" selections evaluate to true These values can be reversed if @not is set to true Renamed from: IllegalSelectionTest</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="RuleSingleSelectionSetsType"><xs:attribute name="testItemName" type="xs:NMTOKEN" use="required"><xs:annotation><xs:documentation>The ListItem that is being evaluated for the presence of disallowed selections (in @listItemNames). This attributes contains the @name of one ListItem.</xs:documentation></xs:annotation></xs:attribute></xs:extension></xs:complexContent></xs:complexType>
Complex Type RuleSingleSelectionSetsType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
This Rule restricts combinations of co-selected ListItems (answers). In other words, only zero or one item in the @listItemNames list may be selected at a time. In most cases, all ListItems should be children of a single multi-select question. Legal ("allowed") selections evaluate to falseIllegal selections evaluate to trueThese values can be reversed if @not is set to trueRenamed from: IllegalSelectionSets
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Optional message that appears when the rule evaluates to true
Source
<xs:complexType name="RuleSingleSelectionSetsType"><xs:annotation><xs:documentation>This Rule restricts combinations of co-selected ListItems (answers). In other words, only zero or one item in the @listItemNames list may be selected at a time. In most cases, all ListItems should be children of a single multi-select question. Legal ("allowed") selections evaluate to false Illegal selections evaluate to true These values can be reversed if @not is set to true Renamed from: IllegalSelectionSets</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="FuncBoolBaseType"><xs:attribute name="listItemNames" type="xs:NMTOKENS" use="required"><xs:annotation><xs:documentation>Set of @name references for a set ListItems, delimited by spaces.</xs:documentation></xs:annotation></xs:attribute><xs:attribute default="false" ref="not"><xs:annotation><xs:documentation>If @not="true" then the logical value of the conditions of the parent element is negated; true becomes false and false becomes true.</xs:documentation></xs:annotation></xs:attribute></xs:extension></xs:complexContent></xs:complexType>
Complex Type AlternativesType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
This Rule tests if one (or more) items in a list of items has received a a valid user response (answer). In the simplest case, this Rule allows a user to answer only one of several alternative questions (named in the @itemNames list), and still save a successfully-validated form. In more complex cases, a user can be required to produce a valid response to a specific minimum and maximum number of Questions, Sections, ListItems or Injected parts. The minCard value on each of the alternative items should be set to "0" (i.e., optional) to avoid validation conflicts when minCard greater than 0.The list of Item @name values is contained in @itemNames. The list must contain at least 2 @name values. The minimum number of items to answer is contained in @minAnswered (default value = 1). If there is a maximum number of items to answer, the value is contained in @maxAnswered (default value = 0 meaning unlimited).
List of names of Sections, Questions, ListItems and/or InjectedItems. Each of the named items will evaluate to true or false, based on the following validation rules:If the name points to a Section, then the Section evaluates to true (valid) if all of its descendant items are answered correctly, according to their metadata.If the name points to a Question then the Question evaluates to true (valid) if it is correctly answered according to its metadata, and also, all descendant items are answered correctly, according to their metadata.If the name points to a ListItem then the ListItem evaluates to true (valid) if it is selected, and also, all descendant items are answered correctly according to their metadata.If the name points to an InjectedItem then the InjectedItem evaluates to true (valid) if all descendant items are answered correctly, according to their metadata.The number of true responses are added together. If they satisfy the minAnswered and maxAnswered attribute values, then this type returns true. Otherwise it returns false.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Optional message that appears when the rule evaluates to true
Source
<xs:complexType name="AlternativesType"><xs:annotation><xs:documentation>This Rule tests if one (or more) items in a list of items has received a a valid user response (answer). In the simplest case, this Rule allows a user to answer only one of several alternative questions (named in the @itemNames list), and still save a successfully-validated form. In more complex cases, a user can be required to produce a valid response to a specific minimum and maximum number of Questions, Sections, ListItems or Injected parts. The minCard value on each of the alternative items should be set to "0" (i.e., optional) to avoid validation conflicts when minCard greater than 0. The list of Item @name values is contained in @itemNames. The list must contain at least 2 @name values. The minimum number of items to answer is contained in @minAnswered (default value = 1). If there is a maximum number of items to answer, the value is contained in @maxAnswered (default value = 0 meaning unlimited).</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="FuncBoolBaseType"><xs:attribute default="false" ref="not"><xs:annotation><xs:documentation>If @not="true" then the logical value of the conditions of the parent element is negated; true becomes false and false becomes true.</xs:documentation></xs:annotation></xs:attribute><xs:attribute default="1" name="minAnswered" type="xs:int" use="optional"/><xs:attribute default="0" name="maxAnswered" type="xs:int"><xs:annotation><xs:documentation>@maxAnswered must be 0 or greater than or equal to @minAnswered.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="itemNames" type="xs:NMTOKENS"><xs:annotation><xs:documentation>List of names of Sections, Questions, ListItems and/or InjectedItems. Each of the named items will evaluate to true or false, based on the following validation rules: If the name points to a Section, then the Section evaluates to true (valid) if all of its descendant items are answered correctly, according to their metadata. If the name points to a Question then the Question evaluates to true (valid) if it is correctly answered according to its metadata, and also, all descendant items are answered correctly, according to their metadata. If the name points to a ListItem then the ListItem evaluates to true (valid) if it is selected, and also, all descendant items are answered correctly according to their metadata. If the name points to an InjectedItem then the InjectedItem evaluates to true (valid) if all descendant items are answered correctly, according to their metadata. The number of true responses are added together. If they satisfy the minAnswered and maxAnswered attribute values, then this type returns true. Otherwise it returns false.</xs:documentation></xs:annotation></xs:attribute></xs:extension></xs:complexContent></xs:complexType>
Complex Type ChildItemsType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
ChildItems have descendants that are of type DisplayedType. They may include primary items of type SectionType, QuestionType, InjectFormType, DisplayedType and ButtonType, in any order. The ChildItem separates new child primary items from elements and attributes that are sub-parts of the parent primary item.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:complexType name="ChildItemsType"><xs:annotation><xs:documentation>ChildItems have descendants that are of type DisplayedType. They may include primary items of type SectionType, QuestionType, InjectFormType, DisplayedType and ButtonType, in any order. The ChildItem separates new child primary items from elements and attributes that are sub-parts of the parent primary item.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="ExtensionBaseType"><xs:group maxOccurs="unbounded" ref="ChildElementsGroup"/></xs:extension></xs:complexContent></xs:complexType>
Complex Type QuestionItemType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
Represents questions. Parent items may be Section, Question, and ListItem.
If the ID does not use the default base URI (namespace), then the local baseURI goes here. Note that all IDs must be unique within a form, even if they do not have the same baseURI. Ideally, the baseURI + ID should combine to form a *globally* unique identifier, that uniquely identifies an item in a particular form. The same baseURI and ID may be reused in derived or versioned forms, as long as the context stays the same, and any affected data elements remain unchanged in context and semantics. Following this approach is likely to simplify analytics based on form content.
A globally unique string assigned to a repeating Question or Section, Injected Form, or any selected answer ListItem. This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among sections or questions, including those that are allowed to repeat and nest deeply.
@maxCard is the maximum number of repetitions allowed for a section or question. The default value is 1, indicating that the section or question cannot be repeated on the data entry form. A value of 0 indicates that the number of repeats is unlimited. If @maxCard is not 0, then Must be greater than or equal to minCard.
@minCard is the minimum number of repetitions allowed for a section or question. The default value is 1, indicating that the user must answer any question(s) that has this attribute set. If @minCard is set to 0, then the item and all descendent questions are optional to answer.
If this attribute is set to "true" (the default), then the form implementation must make this item available for use on the form. If this attribute is set to "false" on a parent or ancestor item, then all child/descendant items inherit this "false" setting, even if they have this attribute set to "true." In other words, the child/descendent items do not need to be implemented if any parent/ancestor item has this attribute set to false.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
A globally unique string assigned from a Section, Question, ListItem or InjectedForm to the ID of its parent node (S, Q, LI or IF). This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among the above objects, including those that are allowed to repeat and nest deeply.
If @readOnly is set to true, the this field may not be edited by the user, and any default values set by template should be considered part of the stored data set responses, and transmitted by the SubmitForm transaction.
Allows the form filler to specify whether the current response is the initial response, or records the type of change made since the initial response was reported.
CHANGED to T/F/OptionalIf @showInReport on a Question is false, then the Question and its ListItems (if any) should not be present in a typical report derived from this template. If this attribute appears on a ListItem, then the entire question and all ListItems should be omitted from the report. If this attribute appears on a Section, then the entire Section and all Section contents (descendents) should be omitted from the report. If @showInReport appears on a DisplayedItem, then the DisplayedItem (and all sub-items) should be omitted from the report.This attribute is usually set to false when a Question is used to control form behavior (e.g., skip logic), or when the Question provides unhelpful "negative" information about actions that did not occur or were not performed, or things that were not observed.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
If the ID does not use the default base URI (namespace), then the local baseURI goes here. Note that all IDs must be unique within a form, even if they do not have the same baseURI. Ideally, the baseURI + ID should combine to form a *globally* unique identifier, that uniquely identifies an item in a particular form. The same baseURI and ID may be reused in derived or versioned forms, as long as the context stays the same, and any affected data elements remain unchanged in context and semantics. Following this approach is likely to simplify analytics based on form content.
A globally unique string assigned to a repeating Question or Section, Injected Form, or any selected answer ListItem. This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among sections or questions, including those that are allowed to repeat and nest deeply.
@maxCard is the maximum number of repetitions allowed for a section or question. The default value is 1, indicating that the section or question cannot be repeated on the data entry form. A value of 0 indicates that the number of repeats is unlimited. If @maxCard is not 0, then Must be greater than or equal to minCard.
@minCard is the minimum number of repetitions allowed for a section or question. The default value is 1, indicating that the user must answer any question(s) that has this attribute set. If @minCard is set to 0, then the item and all descendent questions are optional to answer.
If this attribute is set to "true" (the default), then the form implementation must make this item available for use on the form. If this attribute is set to "false" on a parent or ancestor item, then all child/descendant items inherit this "false" setting, even if they have this attribute set to "true." In other words, the child/descendent items do not need to be implemented if any parent/ancestor item has this attribute set to false.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
A globally unique string assigned from a Section, Question, ListItem or InjectedForm to the ID of its parent node (S, Q, LI or IF). This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among the above objects, including those that are allowed to repeat and nest deeply.
If @readOnly is set to true, the this field may not be edited by the user, and any default values set by template should be considered part of the stored data set responses, and transmitted by the SubmitForm transaction.
Allows the form filler to specify whether the current response is the initial response, or records the type of change made since the initial response was reported.
CHANGED to T/F/OptionalIf @showInReport on a Question is false, then the Question and its ListItems (if any) should not be present in a typical report derived from this template. If this attribute appears on a ListItem, then the entire question and all ListItems should be omitted from the report. If this attribute appears on a Section, then the entire Section and all Section contents (descendents) should be omitted from the report. If @showInReport appears on a DisplayedItem, then the DisplayedItem (and all sub-items) should be omitted from the report.This attribute is usually set to false when a Question is used to control form behavior (e.g., skip logic), or when the Question provides unhelpful "negative" information about actions that did not occur or were not performed, or things that were not observed.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Determines whether the item should be visible on a computer screen when the form is first displayed.
Source
<xs:complexType name="QuestionItemBaseType" abstract="true"><xs:annotation><xs:documentation>Represents questions. Parent items may be Section, Question, and ListItem.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="RepeatingType"><xs:choice maxOccurs="1"><xs:annotation><xs:documentation>Choice (ResponseField, ListField)</xs:documentation></xs:annotation><xs:element name="ResponseField" type="ResponseFieldType" minOccurs="1" maxOccurs="1"/><xs:element name="ListField" minOccurs="1" maxOccurs="1" type="ListFieldType"></xs:element></xs:choice><xs:attribute default="false" name="readOnly" type="xs:boolean"><xs:annotation><xs:documentation>If @readOnly is set to true, the this field may not be edited by the user, and any default values set by template should be considered part of the stored data set responses, and transmitted by the SubmitForm transaction.</xs:documentation></xs:annotation></xs:attribute><xs:attributeGroup ref="ResponseAttributes"/></xs:extension></xs:complexContent></xs:complexType>
Complex Type ResponseFieldType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
This type is a template for a data entry field that accepts entries (responses or answers) of any data type, including text, numbers, dates, and Base 64 - encoded blobs (images, sounds, video, other binary formats, etc.). This type cannot contain ListItems, but it may be a child of a Question or a ListItem.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:complexType name="ResponseFieldType"><xs:annotation><xs:documentation>This type is a template for a data entry field that accepts entries (responses or answers) of any data type, including text, numbers, dates, and Base 64 - encoded blobs (images, sounds, video, other binary formats, etc.). This type cannot contain ListItems, but it may be a child of a Question or a ListItem.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="ExtensionBaseType"><xs:sequence><xs:sequence><xs:element name="Response" type="DataTypes_DEType" minOccurs="1" maxOccurs="1"><xs:annotation><xs:documentation>W3C Schema data type details</xs:documentation></xs:annotation></xs:element><xs:choice minOccurs="0"><xs:element name="CallSetValue" type="CallFuncType"><xs:annotation><xs:documentation>NEW</xs:documentation></xs:annotation></xs:element><xs:element name="SetValue" type="ScriptCodeAnyType"><xs:annotation><xs:documentation>NEW</xs:documentation></xs:annotation></xs:element></xs:choice></xs:sequence><xs:element name="TextAfterResponse" type="RichTextType" minOccurs="0" maxOccurs="1"><xs:annotation><xs:documentation>TextAfterResponse is fixed text that appears after (to the right of) the user's response on the data entry form. This may be text for units such as "mm", "cm", etc.</xs:documentation></xs:annotation></xs:element><xs:element name="ResponseUnits" minOccurs="0" maxOccurs="1" type="UnitsType"><xs:annotation><xs:documentation/></xs:annotation></xs:element><xs:element maxOccurs="unbounded" name="AfterChange" type="EventType" minOccurs="0"><xs:annotation><xs:documentation>Event that occurs after the Response value is changed, usually fired after a user leaves the Response field.</xs:documentation></xs:annotation></xs:element><xs:element maxOccurs="unbounded" minOccurs="0" name="OnEvent" type="OnEventType"/></xs:sequence></xs:extension></xs:complexContent></xs:complexType>
Complex Type ListFieldType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
ListField is a grouper for list-like answer choices, which may be derived from either a set of answer choice lists (a List composed of ListItems) or or a list obtained from a LookupEndpoint URI.
Data type enumeration derived from W3C XML Schema. This element is used only if the ListItems are all associated with coded values from a single coding system.
Maximum number of answer choices (list items) that can be selected by the user. Must be greater than or equal to minSelections, and no larger than the total number of list items. A value of 0 indicates no limit to the number of selected list items (answers). This effectively means that the question is multi-select. (Abbreviated as QM)A value of 1 (the default) indicates that the question list is single-select. (Abbreviated as QS)
Minimum number of answer choices (list items) that must be selected by the user. Default value is 1.NEW: changed minimum value to 1.Removed: If set to 0, then this question need not be answered by the user.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:complexType name="ListFieldType"><xs:annotation><xs:documentation>ListField is a grouper for list-like answer choices, which may be derived from either a set of answer choice lists (a List composed of ListItems) or or a list obtained from a LookupEndpoint URI.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="ExtensionBaseType"><xs:sequence><xs:element minOccurs="0" name="ListHeaderText" type="RichTextType"><xs:annotation><xs:documentation>The header row for a set of list items. If the list has more than one column, the column text is separated by the colTextDelimiter.</xs:documentation></xs:annotation></xs:element><xs:element maxOccurs="1" minOccurs="0" name="DefaultCodeSystem" type="CodeSystemType"><xs:annotation><xs:documentation>If coded values are used for items in a List (including ListItem and LookupEndPoint lists), then the default coding system should be specified here. For ListItem nodes, any exceptions to the coding system may be specified on the individual ListItem nodes. For LookupEndPoints, the endpoint data can optionally specify any exceptions in a dedicated CodeSystem column in the returned list data.</xs:documentation></xs:annotation></xs:element><xs:choice><xs:element name="List" type="ListType"><xs:annotation><xs:documentation>List refers to a set of possible answer choices for the user to select. Child DisplayedItems may be interspersed with Child ListItems. At least one ListItem must be present for a multi-select question, and at least two ListItems must pre present for single-select questions.</xs:documentation></xs:annotation></xs:element><xs:element name="LookupEndPoint" minOccurs="1" maxOccurs="1" type="LookupEndPointType"><xs:annotation><xs:documentation>LookupEndPoint is used when the list items are derived from a web service call of some type, instead of an explicit set of ListItem nodes specified in the FormDesign XML. The endpoint must return a list separated into individual list items by the @colTextDelimiter value specified in the parent ListFieldType.</xs:documentation></xs:annotation></xs:element></xs:choice><xs:element maxOccurs="unbounded" minOccurs="0" name="IllegalListItemPairings" type="RuleSelectionTestType"/><xs:element maxOccurs="unbounded" minOccurs="0" name="IllegalCoSelectedListItems" type="RuleSingleSelectionSetsType"/><xs:element minOccurs="0" name="AfterChange" maxOccurs="unbounded" type="EventType"><xs:annotation><xs:documentation>Event that occurs after List Field selections are changed.</xs:documentation></xs:annotation></xs:element><xs:element maxOccurs="unbounded" minOccurs="0" name="OnEvent" type="OnEventType"/></xs:sequence><xs:attribute default="|" name="colTextDelimiter"><xs:annotation><xs:documentation>Character in the DisplayText that separates the columns and rows in a single or multi-column list.</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:string"><xs:length value="1"/></xs:restriction></xs:simpleType></xs:attribute><xs:attribute default="1" name="numCols" type="xs:unsignedByte"><xs:annotation><xs:documentation>Number of columns in the list</xs:documentation></xs:annotation></xs:attribute><xs:attribute default="1" name="storedCol" type="xs:unsignedByte"><xs:annotation><xs:documentation>Determines which column of the list is stored in a database. This list is one-based.</xs:documentation></xs:annotation></xs:attribute><xs:attribute default="1" name="minSelections"><xs:annotation><xs:documentation>Minimum number of answer choices (list items) that must be selected by the user. Default value is 1. NEW: changed minimum value to 1. Removed: If set to 0, then this question need not be answered by the user.</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:unsignedShort"><xs:minInclusive value="1"/></xs:restriction></xs:simpleType></xs:attribute><xs:attribute default="1" name="maxSelections" type="xs:unsignedShort"><xs:annotation><xs:documentation>Maximum number of answer choices (list items) that can be selected by the user. Must be greater than or equal to minSelections, and no larger than the total number of list items. A value of 0 indicates no limit to the number of selected list items (answers). This effectively means that the question is multi-select. (Abbreviated as QM) A value of 1 (the default) indicates that the question list is single-select. (Abbreviated as QS)</xs:documentation></xs:annotation></xs:attribute><xs:attribute default="true" name="ordered" type="xs:boolean"><xs:annotation><xs:documentation>If false, then the form implementation may change the order of items in the list.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="defaultListItemDataType" type="DataTypeAll_StypeEnum"><xs:annotation><xs:documentation>Data type enumeration derived from W3C XML Schema. This element is used only if the ListItems are all associated with coded values from a single coding system.</xs:documentation></xs:annotation></xs:attribute></xs:extension></xs:complexContent></xs:complexType>
Complex Type ListType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
This type represents a list of specified answer choices. CHANGED 9/20/2016: Fix for serialization error which aggregated all DisplayedItems at the top of the ListItems.A Schematron (or similar validation tool) will be required to ensure that at least 2 ListItems are present for single-select questions, and one ListItem for multi-select questions.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:complexType name="ListType"><xs:annotation><xs:documentation>This type represents a list of specified answer choices. CHANGED 9/20/2016: Fix for serialization error which aggregated all DisplayedItems at the top of the ListItems. A Schematron (or similar validation tool) will be required to ensure that at least 2 ListItems are present for single-select questions, and one ListItem for multi-select questions.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="ExtensionBaseType"><xs:choice maxOccurs="unbounded"><xs:element minOccurs="0" name="DisplayedItem" type="DisplayedType"/><xs:element name="ListItem" type="ListItemType" minOccurs="1" maxOccurs="1"/></xs:choice></xs:extension></xs:complexContent></xs:complexType>
Complex Type ListItemType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
ListItem elements represent answer choices that may appear under a Question.
A typed value (e.g., an integer) that is uniquely associated with a ListItem. An example is the integer 10 for a ListItem with title that reads "10 o'clock". Typically these values are set to be used in calculations or other algorithms. In general, they can be treated something like a user-entered response on a the ListItemResponseField of a selected ListItem.This field should not be used for terminologies or local codes. The CodedValue type should be used for these kinds of metadata. This field should also not be used other properties such as translations, usage, etc.The data type shoudl be specified in @AssociatedValueType
If the ID does not use the default base URI (namespace), then the local baseURI goes here. Note that all IDs must be unique within a form, even if they do not have the same baseURI. Ideally, the baseURI + ID should combine to form a *globally* unique identifier, that uniquely identifies an item in a particular form. The same baseURI and ID may be reused in derived or versioned forms, as long as the context stays the same, and any affected data elements remain unchanged in context and semantics. Following this approach is likely to simplify analytics based on form content.
A globally unique string assigned to a repeating Question or Section, Injected Form, or any selected answer ListItem. This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among sections or questions, including those that are allowed to repeat and nest deeply.
If this attribute is set to "true" (the default), then the form implementation must make this item available for use on the form. If this attribute is set to "false" on a parent or ancestor item, then all child/descendant items inherit this "false" setting, even if they have this attribute set to "true." In other words, the child/descendent items do not need to be implemented if any parent/ancestor item has this attribute set to false.
NEW: If @omitWhenSelected is set to true, then the question and its response(s) should not be present in a typical report derived from this template. This attribute is usually set to true when the answer choice is used to control form behavior (e.g., skip logic), or when the question provides unhelpful "negative" information about actions that did not occur or were not performed, or things that were not observed or could not be assessed. If @omitWhenSelectedset is false (default) then the question and its response(s) should appear in the report. Added 11/29/15 to replace @reportAction
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
A globally unique string assigned from a Section, Question, ListItem or InjectedForm to the ID of its parent node (S, Q, LI or IF). This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among the above objects, including those that are allowed to repeat and nest deeply.
Represents the default value of the ListItem in the FormDesign template, or the user's response in selecting one or more ListItems. If @multiSelect='false' on ListField then only one item may be selected.
NEWSelecting the current ListItem will enable the named items in this attribute's content.Prefixing any named with a hyphen (-) will reverse the above behaviour (i.e., the named items will be disabled).Unselecting the ListItem will reverse this behaviour.Prefixing the name with a tilde (~) will supress this reversal behavior.
If the ancestor ListField has @multiselect = 'true', then selecting this ListItem should de-select all other ListItem (sibling) nodes except the current one.
If set to true, then selecting this ListItem must deactivate all descendant parts of the form, and ignore any user-entered values in the deactivated part. Deselecting the ListItem should reactivate the descendant items in their state at the time the items were deactivated.If items are disabled, then any data stored in the disabled questions should be removed.
NEWSelecting the current ListItem will select the named ListItems in this attribute's content.Prefixing any named with a hyphen (-) will reverse the above behaviour.Unselecting the ListItem will reverse this behaviour.Prefixing the name with a tilde (~) will suppress this reversal behavior.
CHANGED to T/F/OptionalIf @showInReport on a Question is false, then the Question and its ListItems (if any) should not be present in a typical report derived from this template. If this attribute appears on a ListItem, then the entire question and all ListItems should be omitted from the report. If this attribute appears on a Section, then the entire Section and all Section contents (descendents) should be omitted from the report. If @showInReport appears on a DisplayedItem, then the DisplayedItem (and all sub-items) should be omitted from the report.This attribute is usually set to false when a Question is used to control form behavior (e.g., skip logic), or when the Question provides unhelpful "negative" information about actions that did not occur or were not performed, or things that were not observed.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Determines whether the item should be visible on a computer screen when the form is first displayed.
Source
<xs:complexType name="ListItemType"><xs:annotation><xs:documentation>ListItem elements represent answer choices that may appear under a Question.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="ListItemBaseType"><xs:choice minOccurs="0"><xs:element name="ChildItems" type="ChildItemsType" minOccurs="0"/></xs:choice></xs:extension></xs:complexContent></xs:complexType>
Complex Type ListItemBaseType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
This base element is the foundation for ListItems, but does not include the MainItems sub-group under each ListItem.
A typed value (e.g., an integer) that is uniquely associated with a ListItem. An example is the integer 10 for a ListItem with title that reads "10 o'clock". Typically these values are set to be used in calculations or other algorithms. In general, they can be treated something like a user-entered response on a the ListItemResponseField of a selected ListItem.This field should not be used for terminologies or local codes. The CodedValue type should be used for these kinds of metadata. This field should also not be used other properties such as translations, usage, etc.The data type shoudl be specified in @AssociatedValueType
If the ID does not use the default base URI (namespace), then the local baseURI goes here. Note that all IDs must be unique within a form, even if they do not have the same baseURI. Ideally, the baseURI + ID should combine to form a *globally* unique identifier, that uniquely identifies an item in a particular form. The same baseURI and ID may be reused in derived or versioned forms, as long as the context stays the same, and any affected data elements remain unchanged in context and semantics. Following this approach is likely to simplify analytics based on form content.
A globally unique string assigned to a repeating Question or Section, Injected Form, or any selected answer ListItem. This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among sections or questions, including those that are allowed to repeat and nest deeply.
If this attribute is set to "true" (the default), then the form implementation must make this item available for use on the form. If this attribute is set to "false" on a parent or ancestor item, then all child/descendant items inherit this "false" setting, even if they have this attribute set to "true." In other words, the child/descendent items do not need to be implemented if any parent/ancestor item has this attribute set to false.
NEW: If @omitWhenSelected is set to true, then the question and its response(s) should not be present in a typical report derived from this template. This attribute is usually set to true when the answer choice is used to control form behavior (e.g., skip logic), or when the question provides unhelpful "negative" information about actions that did not occur or were not performed, or things that were not observed or could not be assessed. If @omitWhenSelectedset is false (default) then the question and its response(s) should appear in the report. Added 11/29/15 to replace @reportAction
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
A globally unique string assigned from a Section, Question, ListItem or InjectedForm to the ID of its parent node (S, Q, LI or IF). This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among the above objects, including those that are allowed to repeat and nest deeply.
Represents the default value of the ListItem in the FormDesign template, or the user's response in selecting one or more ListItems. If @multiSelect='false' on ListField then only one item may be selected.
NEWSelecting the current ListItem will enable the named items in this attribute's content.Prefixing any named with a hyphen (-) will reverse the above behaviour (i.e., the named items will be disabled).Unselecting the ListItem will reverse this behaviour.Prefixing the name with a tilde (~) will supress this reversal behavior.
If the ancestor ListField has @multiselect = 'true', then selecting this ListItem should de-select all other ListItem (sibling) nodes except the current one.
If set to true, then selecting this ListItem must deactivate all descendant parts of the form, and ignore any user-entered values in the deactivated part. Deselecting the ListItem should reactivate the descendant items in their state at the time the items were deactivated.If items are disabled, then any data stored in the disabled questions should be removed.
NEWSelecting the current ListItem will select the named ListItems in this attribute's content.Prefixing any named with a hyphen (-) will reverse the above behaviour.Unselecting the ListItem will reverse this behaviour.Prefixing the name with a tilde (~) will suppress this reversal behavior.
CHANGED to T/F/OptionalIf @showInReport on a Question is false, then the Question and its ListItems (if any) should not be present in a typical report derived from this template. If this attribute appears on a ListItem, then the entire question and all ListItems should be omitted from the report. If this attribute appears on a Section, then the entire Section and all Section contents (descendents) should be omitted from the report. If @showInReport appears on a DisplayedItem, then the DisplayedItem (and all sub-items) should be omitted from the report.This attribute is usually set to false when a Question is used to control form behavior (e.g., skip logic), or when the Question provides unhelpful "negative" information about actions that did not occur or were not performed, or things that were not observed.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Determines whether the item should be visible on a computer screen when the form is first displayed.
Source
<xs:complexType name="ListItemBaseType" block="" abstract="true"><xs:annotation><xs:documentation>This base element is the foundation for ListItems, but does not include the MainItems sub-group under each ListItem.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="DisplayedType"><xs:sequence><xs:element name="ListItemResponseField" minOccurs="0" maxOccurs="1" type="ListItemResponseFieldType"><xs:annotation><xs:documentation>A place to enter values (of any data type) that are directly associated with, and attached to, a selected answer choice.</xs:documentation></xs:annotation></xs:element><xs:element name="OnSelect" maxOccurs="unbounded" minOccurs="0" type="EventType"></xs:element><xs:element name="OnDeselect" maxOccurs="unbounded" minOccurs="0" type="EventType"></xs:element><xs:element name="SelectIf" minOccurs="0" type="GuardType"></xs:element><xs:element name="DeselectIf" minOccurs="0" type="GuardType"></xs:element></xs:sequence><xs:attribute default="false" name="selected" type="xs:boolean"><xs:annotation><xs:documentation>Represents the default value of the ListItem in the FormDesign template, or the user's response in selecting one or more ListItems. If @multiSelect='false' on ListField then only one item may be selected.</xs:documentation></xs:annotation></xs:attribute><xs:attribute default="false" name="selectionDisablesChildren" type="xs:boolean"><xs:annotation><xs:documentation>If set to true, then selecting this ListItem must deactivate all descendant parts of the form, and ignore any user-entered values in the deactivated part. Deselecting the ListItem should reactivate the descendant items in their state at the time the items were deactivated. If items are disabled, then any data stored in the disabled questions should be removed.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="selectionActivatesItems" type="xs:NMTOKENS"><xs:annotation><xs:documentation>NEW Selecting the current ListItem will enable the named items in this attribute's content. Prefixing any named with a hyphen (-) will reverse the above behaviour (i.e., the named items will be disabled). Unselecting the ListItem will reverse this behaviour. Prefixing the name with a tilde (~) will supress this reversal behavior.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="selectionSelectsListItems" type="xs:NMTOKENS"><xs:annotation><xs:documentation>NEW Selecting the current ListItem will select the named ListItems in this attribute's content. Prefixing any named with a hyphen (-) will reverse the above behaviour. Unselecting the ListItem will reverse this behaviour. Prefixing the name with a tilde (~) will suppress this reversal behavior.</xs:documentation></xs:annotation></xs:attribute><xs:attribute default="false" name="selectionDeselectsSiblings" type="xs:boolean"><xs:annotation><xs:documentation>If the ancestor ListField has @multiselect = 'true', then selecting this ListItem should de-select all other ListItem (sibling) nodes except the current one.</xs:documentation></xs:annotation></xs:attribute><xs:attribute default="false" name="omitWhenSelected" type="xs:boolean"><xs:annotation><xs:documentation>NEW: If @omitWhenSelected is set to true, then the question and its response(s) should not be present in a typical report derived from this template. This attribute is usually set to true when the answer choice is used to control form behavior (e.g., skip logic), or when the question provides unhelpful "negative" information about actions that did not occur or were not performed, or things that were not observed or could not be assessed. If @omitWhenSelectedset is false (default) then the question and its response(s) should appear in the report. Added 11/29/15 to replace @reportAction</xs:documentation></xs:annotation></xs:attribute><xs:attributeGroup ref="ResponseReportingAttributes"/><xs:attribute name="associatedValue" type="xs:string"><xs:annotation><xs:documentation>A typed value (e.g., an integer) that is uniquely associated with a ListItem. An example is the integer 10 for a ListItem with title that reads "10 o'clock". Typically these values are set to be used in calculations or other algorithms. In general, they can be treated something like a user-entered response on a the ListItemResponseField of a selected ListItem. This field should not be used for terminologies or local codes. The CodedValue type should be used for these kinds of metadata. This field should also not be used other properties such as translations, usage, etc. The data type shoudl be specified in @AssociatedValueType</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="associatedValueType" type="DataTypeAll_StypeEnum"><xs:annotation><xs:documentation>The data type of @AssociatedValue. Default is string.</xs:documentation></xs:annotation></xs:attribute></xs:extension></xs:complexContent></xs:complexType>
Complex Type ListItemResponseFieldType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
This type represents a place to store a fill-in response associated directly with a selected ListItem. The response may be optional or required.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:complexType name="ListItemResponseFieldType"><xs:annotation><xs:documentation>This type represents a place to store a fill-in response associated directly with a selected ListItem. The response may be optional or required.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="ResponseFieldType"><xs:attribute name="responseRequired" type="xs:boolean" default="false"><xs:annotation><xs:documentation>If @responseRequired is set to true, then the appropriate text or Blob must be entered in the data-entry field associated with this list item.</xs:documentation></xs:annotation></xs:attribute></xs:extension></xs:complexContent></xs:complexType>
Complex Type LookupEndPointType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
LookupEndPointType represents list items that are derived from a web service call of some type, instead of an explicit set of ListItem nodes specified in the FormDesign XML. The endpoint must return a list separated into individual list items by the @colTextDelimiter value specified in the parent ListFieldType.
Defines the data type held by a string value.Also defines the dataType for list items in a list, which uses the generic string type, since string can represent any XML data type. List items of any data type should be validated by the implementation software, since all data types are written into an XML list of type string.For typed items included by reference to an external (reference or variable) value, use short name strings preceded by "$".
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:complexType name="LookupEndPointType"><xs:annotation><xs:documentation>LookupEndPointType represents list items that are derived from a web service call of some type, instead of an explicit set of ListItem nodes specified in the FormDesign XML. The endpoint must return a list separated into individual list items by the @colTextDelimiter value specified in the parent ListFieldType.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="CallFuncType"><xs:sequence maxOccurs="1"><xs:element maxOccurs="unbounded" minOccurs="0" name="ResponseValue" type="CodingType"><xs:annotation><xs:documentation>The user's response to the lookup list. The response is recorded as a coding, terminology, classification, keyword, or local value. Multiple selections from the lookup list may be allowed.</xs:documentation></xs:annotation></xs:element></xs:sequence><xs:attribute name="includesHeaderRow" type="xs:boolean" default="false"/></xs:extension></xs:complexContent></xs:complexType>
Complex Type ButtonItemType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
The ButtonAction type represents a visual area for a user to click, and the click triggers a piece of "Action" code to run inside the form. The ButtonAction object may be represented with a visible button object, or some other type of visual paradigm. Other types of actions (e.g. key presses in a text field) may be handled with the form framework's event model.
If the ID does not use the default base URI (namespace), then the local baseURI goes here. Note that all IDs must be unique within a form, even if they do not have the same baseURI. Ideally, the baseURI + ID should combine to form a *globally* unique identifier, that uniquely identifies an item in a particular form. The same baseURI and ID may be reused in derived or versioned forms, as long as the context stays the same, and any affected data elements remain unchanged in context and semantics. Following this approach is likely to simplify analytics based on form content.
If this attribute is set to "true" (the default), then the form implementation must make this item available for use on the form. If this attribute is set to "false" on a parent or ancestor item, then all child/descendant items inherit this "false" setting, even if they have this attribute set to "true." In other words, the child/descendent items do not need to be implemented if any parent/ancestor item has this attribute set to false.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
CHANGED to T/F/OptionalIf @showInReport on a Question is false, then the Question and its ListItems (if any) should not be present in a typical report derived from this template. If this attribute appears on a ListItem, then the entire question and all ListItems should be omitted from the report. If this attribute appears on a Section, then the entire Section and all Section contents (descendents) should be omitted from the report. If @showInReport appears on a DisplayedItem, then the DisplayedItem (and all sub-items) should be omitted from the report.This attribute is usually set to false when a Question is used to control form behavior (e.g., skip logic), or when the Question provides unhelpful "negative" information about actions that did not occur or were not performed, or things that were not observed.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Determines whether the item should be visible on a computer screen when the form is first displayed.
Source
<xs:complexType name="ButtonItemType"><xs:annotation><xs:documentation>The ButtonAction type represents a visual area for a user to click, and the click triggers a piece of "Action" code to run inside the form. The ButtonAction object may be represented with a visible button object, or some other type of visual paradigm. Other types of actions (e.g. key presses in a text field) may be handled with the form framework's event model.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="DisplayedType"><xs:choice><xs:element minOccurs="0" name="OnClick" type="EventType"/></xs:choice></xs:extension></xs:complexContent></xs:complexType>
Complex Type RulesType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
Rules are procedures that affect form behaviour. They are usually triggered by changes to the form by a form user. They may also be triggered by other rules or changes to form metadata (e.g., change to @visible).SDC decarative form rules consist of several types:Assertions are "predicate" expressions that evaulate to true or false, based upon the state of answers/responses or metadata within a form. An asserion is equivalent to the "If" part of an If-Then block. The implementation framework must assign a fucntion to handle any assertion that evaluates to False. Assertions are no handled by the form itself.If-Then-Else blocks run a "Then" action if the "If block evaluated to true, and an "Else" block if the "If" block evaluates to false.An AutoSelection rule automatically selects an answer choice (ListItem) when another answer (or set of answers) is selected or unselected.IllegalSelectionTest evaluates to true if a disallowed set of answer choices is selected at the same time. The implementation should take an action (alert user, cancel inout, etc) when a true result occurs.IllegalSelection Set restricts combinations of co-selected ListItems (answers). In other words, only zero or one item in this list may be selected at a time.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:complexType name="RulesType"><xs:annotation><xs:documentation>Rules are procedures that affect form behaviour. They are usually triggered by changes to the form by a form user. They may also be triggered by other rules or changes to form metadata (e.g., change to @visible). SDC decarative form rules consist of several types: Assertions are "predicate" expressions that evaulate to true or false, based upon the state of answers/responses or metadata within a form. An asserion is equivalent to the "If" part of an If-Then block. The implementation framework must assign a fucntion to handle any assertion that evaluates to False. Assertions are no handled by the form itself. If-Then-Else blocks run a "Then" action if the "If block evaluated to true, and an "Else" block if the "If" block evaluates to false. An AutoSelection rule automatically selects an answer choice (ListItem) when another answer (or set of answers) is selected or unselected. IllegalSelectionTest evaluates to true if a disallowed set of answer choices is selected at the same time. The implementation should take an action (alert user, cancel inout, etc) when a true result occurs. IllegalSelection Set restricts combinations of co-selected ListItems (answers). In other words, only zero or one item in this list may be selected at a time.</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="ExtensionBaseType"><xs:sequence><xs:element minOccurs="0" name="Validation"><xs:complexType><xs:complexContent><xs:extension base="ExtensionBaseType"><xs:choice maxOccurs="unbounded"><xs:element maxOccurs="unbounded" minOccurs="0" name="IllegalSelectionTest" type="RuleSelectionTestType"><xs:annotation><xs:documentation/></xs:annotation></xs:element><xs:element name="IllegalSelectionSets" maxOccurs="unbounded" minOccurs="0" type="RuleSingleSelectionSetsType"></xs:element><xs:element name="ItemAlternatives" maxOccurs="unbounded" minOccurs="0" type="AlternativesType"><xs:annotation><xs:documentation/></xs:annotation></xs:element></xs:choice></xs:extension></xs:complexContent></xs:complexType></xs:element><xs:element name="AutoActivation" type="RuleAutoActivationType" maxOccurs="unbounded" minOccurs="0"/><xs:element maxOccurs="unbounded" minOccurs="0" name="AutoSelection" type="RuleAutoSelectType"/><xs:element maxOccurs="unbounded" minOccurs="0" name="ConditionalGroupActions" type="ConditionalGroupActionType"/><xs:element maxOccurs="unbounded" minOccurs="0" name="ScriptedRule" type="ScriptCodeAnyType"><xs:annotation><xs:documentation/></xs:annotation></xs:element><xs:element maxOccurs="unbounded" minOccurs="0" name="ExternalRule" type="CallFuncType"><xs:annotation><xs:documentation>Rules that are called (by referencing the rule's @name attribute) from another place in the form.</xs:documentation></xs:annotation></xs:element></xs:sequence></xs:extension></xs:complexContent></xs:complexType>
Complex Type RuleAutoActivationType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
This Rule sets the activation status of Items based on the selection status of other ListItems.This declarative rule determines (guards) when target Items should be activated or deactivated. The rule may optionally activate/deactivate multiple target items with a single rule. The target item(s) to activate/deactivate are listed in targetNameList.In the simplest case, this rule operates as follows: A list of ListItems is provided (selectedItemWatchList). If all the items in the list are selected (or unselected - see below) as specified in the selectedItemWatchList list, then the guard evaluates to true, and the targetNameList items are activated/deactivated.In some cases, we may wish to watch unselected items in the selectedItemWatchList. This is indicated by prefixing the name of the watched item with a minus sign/dash ("-").In some cases, we may wish to deactivate items in the targetNameSelectList list when the selectedItemWatchList evaluated to true. In this case, the target item is prefixed with a dash ("-").
(reversible); If onlyIf is true, then the stipulated Boolean actions, which are executed when the If conditions evaluate to true, are reversed when the conditions evaluate to false.If onlyIf="true", the target items assume the chosen attribute values (e.g., selected, activated) ONLY when the action condition(s) are satisfied. If the conditions are not satisfied, then all Boolean actions assume the opposite state (e.g., unselected, inactive).Manually changing the attributes on the target item (upon which the actions are executed) will not affect any attributes in the controlling items. It is possible to disable (enabled="false") the target item so that its attributes can only be be changed programmatically.The default value is "false" indicating that the the rule runs when the "If" condition is "true." The attached action will not reverse (be undone) when the "If" condition evaluates to "false."
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
Delete all user selections, responses and comments when the item is deactivated. Applies to all descendant items as well. User should be warned before deleting anything, with an option to preserve the responses in the disabled items. Disabled item responses should not be saved with the form data.
This list contains names of ListItems (answer choices) that are watched for being selected or unselected.If a ListItem appears in this list, then it evaluates to true when it is selected. If a ListItem is prefixed with a hyphen (-), then it evaluates to true when unselected. These Boolean values, derived from each named ListItem in the list, are ANDed together (by default) to produce a return value of true or false. The default Boolean operator (AND) may be changed using @boolOp. If @not = true, then the Boolean result is logically negated.Renamed from: ListItemSelections
This list contains the @names of Identified Items that will be automatically activated or deactivated when the @selectedItemSet evaluates to true. If a @name is prefixed with a hyphen (-), then the item will be deactivated when @selectedItemSet evaluates to true. If @not = true, then the Boolean rule evaluation is negated, and thus the rule works in reverse.If @onlyIf is true, then the above rule is reversed when @selectedItemSet evaluates to false. In other words, named items will be deactivated, and hyphen-prefixed items will be activated when @selectedItemSet is false.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:complexType name="RuleAutoActivationType"><xs:annotation><xs:documentation>This Rule sets the activation status of Items based on the selection status of other ListItems. This declarative rule determines (guards) when target Items should be activated or deactivated. The rule may optionally activate/deactivate multiple target items with a single rule. The target item(s) to activate/deactivate are listed in targetNameList. In the simplest case, this rule operates as follows: A list of ListItems is provided (selectedItemWatchList). If all the items in the list are selected (or unselected - see below) as specified in the selectedItemWatchList list, then the guard evaluates to true, and the targetNameList items are activated/deactivated. In some cases, we may wish to watch unselected items in the selectedItemWatchList. This is indicated by prefixing the name of the watched item with a minus sign/dash ("-"). In some cases, we may wish to deactivate items in the targetNameSelectList list when the selectedItemWatchList evaluated to true. In this case, the target item is prefixed with a dash ("-").</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="ExtensionBaseType"><xs:attributeGroup ref="SelectionDependencyAttributes"/><xs:attributeGroup ref="IfAttributes"/><xs:attribute name="targetNameActivationList" type="xs:NCName"><xs:annotation><xs:documentation>This list contains the @names of Identified Items that will be automatically activated or deactivated when the @selectedItemSet evaluates to true. If a @name is prefixed with a hyphen (-), then the item will be deactivated when @selectedItemSet evaluates to true. If @not = true, then the Boolean rule evaluation is negated, and thus the rule works in reverse. If @onlyIf is true, then the above rule is reversed when @selectedItemSet evaluates to false. In other words, named items will be deactivated, and hyphen-prefixed items will be activated when @selectedItemSet is false.</xs:documentation></xs:annotation></xs:attribute><xs:attribute default="true" name="setVisibility" type="toggleType"><xs:annotation><xs:documentation>Make target items visible when activated and vice versa. Default = false. All descendants are affected in the same way.</xs:documentation></xs:annotation></xs:attribute><xs:attribute default="true" name="setEnabled" type="toggleType"><xs:annotation><xs:documentation>Make target items enabled when activated and vice versa. Default = true. All descendants are affected in the same way.</xs:documentation></xs:annotation></xs:attribute><xs:attribute default="true" name="setExpanded" type="toggleType"><xs:annotation><xs:documentation>Expand target items when activated and collapse item when deactivated. Default = false. All descendants are affected in the same way.</xs:documentation></xs:annotation></xs:attribute><xs:attribute default="false" name="removeResponsesWhenDeactivated" type="xs:boolean"><xs:annotation><xs:documentation>Delete all user selections, responses and comments when the item is deactivated. Applies to all descendant items as well. User should be warned before deleting anything, with an option to preserve the responses in the disabled items. Disabled item responses should not be saved with the form data.</xs:documentation></xs:annotation></xs:attribute></xs:extension></xs:complexContent></xs:complexType>
Complex Type RuleAutoSelectType
Namespace
urn:ihe:qrph:sdc:2016
Annotations
This Rule selects/unselects ListItems based on the selected status of other ListItems.This declarative rule determines (guards) when target ListItems should be selected or unselected. The guard rule may optionally select/unselect multiple target ListItems with a single rule. The target ListItem(s) to select/unselect are listed in targetNameSelectList.In the simplest case, this rule operates as follows: A list of ListItems is provided (selectedItemWatchList). If all the items in the list are selected (or unselected - see below) as specified in the selectedItemWatchList list, then the guard evaluates to true, and the targetNameSelectList items are selected.In some cases, we may wish to watch unselected items in the selectedItemWatchList. This is indicated by prefixing the name of the watched item with a minus sign/dash ("-").In some cases, we may wish to unselect items in the targetNameSelectList list when the selectedItemWatchList evaluated to true. In this case, the target item is prefixed with a dash ("-").
(reversible); If onlyIf is true, then the stipulated Boolean actions, which are executed when the If conditions evaluate to true, are reversed when the conditions evaluate to false.If onlyIf="true", the target items assume the chosen attribute values (e.g., selected, activated) ONLY when the action condition(s) are satisfied. If the conditions are not satisfied, then all Boolean actions assume the opposite state (e.g., unselected, inactive).Manually changing the attributes on the target item (upon which the actions are executed) will not affect any attributes in the controlling items. It is possible to disable (enabled="false") the target item so that its attributes can only be be changed programmatically.The default value is "false" indicating that the the rule runs when the "If" condition is "true." The attached action will not reverse (be undone) when the "If" condition evaluates to "false."
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
This list contains names of ListItems (answer choices) that are watched for being selected or unselected.If a ListItem appears in this list, then it evaluates to true when it is selected. If a ListItem is prefixed with a hyphen (-), then it evaluates to true when unselected. These Boolean values, derived from each named ListItem in the list, are ANDed together (by default) to produce a return value of true or false. The default Boolean operator (AND) may be changed using @boolOp. If @not = true, then the Boolean result is logically negated.Renamed from: ListItemSelections
This list contains the @names of ListItems that will be automatically selected or deselected when the @selectedItemSet evaluates to true. If a @name is prefixed with a hyphen (-), then the item will be deselected when @selectedItemSet evaluates to true. If @not = true, then the Boolean rule evaluation is negated, and thus the rule works in reverse.If @onlyIf is true, then the above rule is reversed when @selectedItemSet evaluates to false. In other words, named items will be deselected, and hyphen-prefixed items will be selected when @selectedItemSet is false.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
Source
<xs:complexType name="RuleAutoSelectType"><xs:annotation><xs:documentation>This Rule selects/unselects ListItems based on the selected status of other ListItems. This declarative rule determines (guards) when target ListItems should be selected or unselected. The guard rule may optionally select/unselect multiple target ListItems with a single rule. The target ListItem(s) to select/unselect are listed in targetNameSelectList. In the simplest case, this rule operates as follows: A list of ListItems is provided (selectedItemWatchList). If all the items in the list are selected (or unselected - see below) as specified in the selectedItemWatchList list, then the guard evaluates to true, and the targetNameSelectList items are selected. In some cases, we may wish to watch unselected items in the selectedItemWatchList. This is indicated by prefixing the name of the watched item with a minus sign/dash ("-"). In some cases, we may wish to unselect items in the targetNameSelectList list when the selectedItemWatchList evaluated to true. In this case, the target item is prefixed with a dash ("-").</xs:documentation></xs:annotation><xs:complexContent><xs:extension base="ExtensionBaseType"><xs:attributeGroup ref="SelectionDependencyAttributes"/><xs:attributeGroup ref="IfAttributes"/><xs:attribute name="targetNameSelectList" type="xs:NCName"><xs:annotation><xs:documentation>This list contains the @names of ListItems that will be automatically selected or deselected when the @selectedItemSet evaluates to true. If a @name is prefixed with a hyphen (-), then the item will be deselected when @selectedItemSet evaluates to true. If @not = true, then the Boolean rule evaluation is negated, and thus the rule works in reverse. If @onlyIf is true, then the above rule is reversed when @selectedItemSet evaluates to false. In other words, named items will be deselected, and hyphen-prefixed items will be selected when @selectedItemSet is false.</xs:documentation></xs:annotation></xs:attribute></xs:extension></xs:complexContent></xs:complexType>
If the ID does not use the default base URI (namespace), then the local baseURI goes here. Note that all IDs must be unique within a form, even if they do not have the same baseURI. Ideally, the baseURI + ID should combine to form a *globally* unique identifier, that uniquely identifies an item in a particular form. The same baseURI and ID may be reused in derived or versioned forms, as long as the context stays the same, and any affected data elements remain unchanged in context and semantics. Following this approach is likely to simplify analytics based on form content.
NEW: URI used to identify the DE that that this DE is based upon. In most cases, this should be a standard form that is modified and/or extended by the current DE. The current template reuses the basedOn IDs whenever the question/answer/semantic context is identical to the original.
NEW: filename to use when the current DE instance is saved as a file. For DEs containing responses, the filename may include the deInstanceVersionURI, but the naming convention may be use-case-specific.
NEW: The full URI that uniquely identifies the current DE. It is created by concatenating @baseURI + lineage + version. Each of the componenets is separated by a single forward slash.
NEW: Unique URI used to identify a unique instance of a DE. Used for tracking DE responses across time and across multiple episodes of editing by end-users. This URI does not change for each edit session of a DE instance.
NEW: Unique URI used to identify a unique instance of a DE's saved responses. It is used for tracking DE responses across time and across multiple episodes of editing by end-users. This URI must change for each edit/save session of a DE instance. It may be e.g., a new GUID, or a repeat of the deInstanceID followed by a version number.
NEW: A text identifier that is used to group multiple versions of a single DE. The lineage is constant for all versions of a single kind of DE. When appended to @baseURI, it can be used to retrieve all versions of one particular DE.
@order allows the form template developer to define a sequentialorder for elements in a template. This serves the purpose of providing adefinitive/original order to sections, questions, answer choices, etc., whenrequired for display purposes. This is important when the original XML orderingmay become disrupted due to the use of an implementation technology that doesnot natively support ordering (e.g., object collections), and it can alsoprovide a check on the proper importing of the XML tree duringimplementation.
NEW: Unique URI used to identify the immediate previous instance of a de containing responses. This is the @deInstanceVersionURI that represents the instance of the form that the user opened up before beginning a new cycle of edit/save. This attribute is used for tracking de responses across time and across multiple episodes of editing by end-users. This URI must change for each edit session of a de instance.
Allows the form filler to specify whether the current response is the initial response, or records the type of change made since the initial response was reported.
The @type attribute can contain custom metadata "tokens" for theelement, chosen from a standardized list of terms. Tokens are short alphanumerictext strings, defined by the W3C Schema NMTOKEN specification, that are definedin an Implementation Guide. The type xsd:NMTOKEN represents a single stringtoken. NMTOKEN values may consist of letters, digits, periods ( . ), hyphens ( -), underscores ( _ ), and colons ( : ). They may start with any of thesecharacters. (www.datypic.com/sc/xsd/t-xsd_NMTOKEN.html) @type tokens may bespecific for one or more kinds of SDC elements. Multiple tokens in the typeattribute should be separated by whitespace. Type tokens may be used to specifyspecial handling by an application, and are usually used to define form displayconstraints, but may include other custom metadata as well. Style metadatashould generally be handled with @styleClass rather than @type. @type tokenexamples include: tooltip, statusLineText, alignTopLeft, align:bottom,_pageBreak-after, etc. @type metadata should generally not affect theinformation content of a form.
NEW: @version contains the version text for the current DE. It is designed to be used in conjuction with @baseURI and @lineage.
Source
<xs:complexType name="DataElementType"><xs:complexContent><xs:extension base="IdentifiedExtensionType"><xs:group maxOccurs="unbounded" ref="ChildElementsGroup"/><xs:attribute name="title" type="xs:string"><xs:annotation><xs:documentation>NEW: human readable title for display when choosing forms. Added 4/27/16</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="filename" type="xs:string"><xs:annotation><xs:documentation>NEW: filename to use when the current DE instance is saved as a file. For DEs containing responses, the filename may include the deInstanceVersionURI, but the naming convention may be use-case-specific.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="basedOnURI" type="URI_Atype"><xs:annotation><xs:documentation>NEW: URI used to identify the DE that that this DE is based upon. In most cases, this should be a standard form that is modified and/or extended by the current DE. The current template reuses the basedOn IDs whenever the question/answer/semantic context is identical to the original.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="lineage" type="xs:string" use="required"><xs:annotation><xs:documentation>NEW: A text identifier that is used to group multiple versions of a single DE. The lineage is constant for all versions of a single kind of DE. When appended to @baseURI, it can be used to retrieve all versions of one particular DE.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="version" type="xs:string" use="required"><xs:annotation><xs:documentation>NEW: @version contains the version text for the current DE. It is designed to be used in conjuction with @baseURI and @lineage.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="fullURI" type="URI_Atype" use="required"><xs:annotation><xs:documentation>NEW: The full URI that uniquely identifies the current DE. It is created by concatenating @baseURI + lineage + version. Each of the componenets is separated by a single forward slash.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="prevVersionURI" type="URI_Atype"><xs:annotation><xs:documentation>NEW: The full URI used to identify the DE that is the immediate previous version of the current DE</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="instanceURI" type="URI_Atype"><xs:annotation><xs:documentation>NEW: Unique URI used to identify a unique instance of a DE. Used for tracking DE responses across time and across multiple episodes of editing by end-users. This URI does not change for each edit session of a DE instance.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="instanceVersionURI" type="URI_Atype"><xs:annotation><xs:documentation>NEW: Unique URI used to identify a unique instance of a DE's saved responses. It is used for tracking DE responses across time and across multiple episodes of editing by end-users. This URI must change for each edit/save session of a DE instance. It may be e.g., a new GUID, or a repeat of the deInstanceID followed by a version number.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="previousInstanceVersionURI" type="URI_Atype"><xs:annotation><xs:documentation>NEW: Unique URI used to identify the immediate previous instance of a de containing responses. This is the @deInstanceVersionURI that represents the instance of the form that the user opened up before beginning a new cycle of edit/save. This attribute is used for tracking de responses across time and across multiple episodes of editing by end-users. This URI must change for each edit session of a de instance.</xs:documentation></xs:annotation></xs:attribute><xs:attributeGroup ref="ResponseAttributes"/></xs:extension></xs:complexContent></xs:complexType>
<xs:attribute name="itemNames" type="xs:NMTOKENS" use="required"><xs:annotation><xs:documentation>Required name(s) of the item(s) (Section, Question, List Item) that contains the item properties used in the other attributes.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="isActive" type="xs:boolean"><xs:annotation><xs:documentation>If visible and enabled are both true, then isActive is true. Otherwise, it is false.</xs:documentation></xs:annotation></xs:attribute>
Applies only to Questions that have selection lists (ListItems or LookupField). Evaluates to true if the number of selected items equals or exceeds the entered value.
<xs:attribute name="hasSelectionsGTE" type="xs:nonNegativeInteger"><xs:annotation><xs:documentation>Applies only to Questions that have selection lists (ListItems or LookupField). Evaluates to true if the number of selected items equals or exceeds the entered value.</xs:documentation></xs:annotation></xs:attribute>
Applies only to Questions that have selection lists (ListItems or LookupField). Evaluates to true if the number of selected items is less than or equal to the entered value.
<xs:attribute name="hasSelectionsLTE" type="xs:nonNegativeInteger"><xs:annotation><xs:documentation>Applies only to Questions that have selection lists (ListItems or LookupField). Evaluates to true if the number of selected items is less than or equal to the entered value.</xs:documentation></xs:annotation></xs:attribute>
Applies only to Questions that have selection lists (ListItems or LookupField). Evaluates to true if the number of selected items equals the entered value.
<xs:attribute name="hasSelectionsExact" type="xs:nonNegativeInteger"><xs:annotation><xs:documentation>Applies only to Questions that have selection lists (ListItems or LookupField). Evaluates to true if the number of selected items equals the entered value.</xs:documentation></xs:annotation></xs:attribute>
Applies only to items that have Response Fields (Questions and ListItems). If the ListItem or Question has a Response Field, and that field has a value in it, this property returns true. If it does not have a value, it returns false. If no Response Field is present, it retuns null and is not used for Boolean comparisons.
<xs:attribute name="hasResponse" type="xs:boolean"><xs:annotation><xs:documentation>Applies only to items that have Response Fields (Questions and ListItems). If the ListItem or Question has a Response Field, and that field has a value in it, this property returns true. If it does not have a value, it returns false. If no Response Field is present, it retuns null and is not used for Boolean comparisons.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="isRequired" type="xs:boolean"><xs:annotation><xs:documentation>If the minCard value is greater than 0, then isRequired = "true" If the minCard = "0" then isRequired = "false"</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="hasAssociatedValue" type="xs:boolean"><xs:annotation><xs:documentation>Applies only to ListItems. If the attribute has a value in it, this property returns true. If it does not have a value, it returns false.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="targetNames" type="xs:NMTOKENS" use="required"><xs:annotation><xs:documentation>The names of the items affected by property actions</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="actMinCard" type="xs:nonNegativeInteger"><xs:annotation><xs:documentation>Controls requirement to answer the question and the minimum number of repeats.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="actMaxCard" type="xs:nonNegativeInteger"><xs:annotation><xs:documentation>Controls requirement to answer the question</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="actActivate" type="xs:boolean"><xs:annotation><xs:documentation>Toggle visible and enabled together. Setting this to false will de-activate all descendents but will not change their enabled or visible properties.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="actSelect" type="xs:boolean"><xs:annotation><xs:documentation>Toggle selection of a List Item; not applicable to other items.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="actDeleteResponse" type="xs:boolean"><xs:annotation><xs:documentation>Delete any response in a Response field on a question or ListItem. Not applicable to other item types.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="actReadOnly" type="xs:boolean"><xs:annotation><xs:documentation>Delete any response in a Response field on a question or ListItem. Not applicable to other item types.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="actSetTitleText" type="xs:string"><xs:annotation><xs:documentation>Set the @title text on an item.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="actSetBase64HTML" type="xs:base64Binary"><xs:annotation><xs:documentation>Set HTML as base-64-encoded binary</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="actSetVal" type="xs:string"><xs:annotation><xs:documentation>Set a @val attribute. The correct data type must be used if applicable.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="actSetAssociatedValue" type="xs:string"><xs:annotation><xs:documentation>Set @associatedValue attribute of a ListItem. The correct data type must be used if applicable.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="elementName" type="xs:NCName" use="required"><xs:annotation><xs:documentation>The @name attribute of the referenced element.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="attributeName" type="xs:NCName" default="val"><xs:annotation><xs:documentation>The name of any attribute on a named element.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="formID" type="URI_Atype"><xs:annotation><xs:documentation>This ID represents the form to be displayed.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="packageID" type="URI_Atype" use="required"><xs:annotation><xs:documentation>This ID represents the Package that contains the form to be displayed.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="reportID" type="URI_Atype"><xs:annotation><xs:documentation>This ID represents the report to be displayed.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="packageID" type="URI_Atype"><xs:annotation><xs:documentation>This ID represents the Package that contains the report to be displayed.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="reportID" type="URI_Atype"><xs:annotation><xs:documentation>This ID represents the report to be displayed.</xs:documentation></xs:annotation></xs:attribute>
This list contains names of ListItems (answer choices) that are watched for being selected or unselected.If a ListItem appears in this list, then it evaluates to true when it is selected. If a ListItem is prefixed with a hyphen (-), then it evaluates to true when unselected. These Boolean values, derived from each named ListItem in the list, are ANDed together (by default) to produce a return value of true or false. The default Boolean operator (AND) may be changed using @boolOp. If @not = true, then the Boolean result is logically negated.Renamed from: ListItemSelections
<xs:attribute use="required" name="selectedItemSet" type="xs:NMTOKENS"><xs:annotation><xs:documentation>This list contains names of ListItems (answer choices) that are watched for being selected or unselected. If a ListItem appears in this list, then it evaluates to true when it is selected. If a ListItem is prefixed with a hyphen (-), then it evaluates to true when unselected. These Boolean values, derived from each named ListItem in the list, are ANDed together (by default) to produce a return value of true or false. The default Boolean operator (AND) may be changed using @boolOp. If @not = true, then the Boolean result is logically negated. Renamed from: ListItemSelections</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="listItemNames" type="xs:NMTOKENS" use="required"><xs:annotation><xs:documentation>Set of @name references for a set ListItems, delimited by spaces.</xs:documentation></xs:annotation></xs:attribute>
The ListItem that is being evaluated for the presence of disallowed selections (in @listItemNames). This attributes contains the @name of one ListItem.
<xs:attribute name="testItemName" type="xs:NMTOKEN" use="required"><xs:annotation><xs:documentation>The ListItem that is being evaluated for the presence of disallowed selections (in @listItemNames). This attributes contains the @name of one ListItem.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute default="0" name="maxAnswered" type="xs:int"><xs:annotation><xs:documentation>@maxAnswered must be 0 or greater than or equal to @minAnswered.</xs:documentation></xs:annotation></xs:attribute>
List of names of Sections, Questions, ListItems and/or InjectedItems. Each of the named items will evaluate to true or false, based on the following validation rules:If the name points to a Section, then the Section evaluates to true (valid) if all of its descendant items are answered correctly, according to their metadata.If the name points to a Question then the Question evaluates to true (valid) if it is correctly answered according to its metadata, and also, all descendant items are answered correctly, according to their metadata.If the name points to a ListItem then the ListItem evaluates to true (valid) if it is selected, and also, all descendant items are answered correctly according to their metadata.If the name points to an InjectedItem then the InjectedItem evaluates to true (valid) if all descendant items are answered correctly, according to their metadata.The number of true responses are added together. If they satisfy the minAnswered and maxAnswered attribute values, then this type returns true. Otherwise it returns false.
<xs:attribute name="itemNames" type="xs:NMTOKENS"><xs:annotation><xs:documentation>List of names of Sections, Questions, ListItems and/or InjectedItems. Each of the named items will evaluate to true or false, based on the following validation rules: If the name points to a Section, then the Section evaluates to true (valid) if all of its descendant items are answered correctly, according to their metadata. If the name points to a Question then the Question evaluates to true (valid) if it is correctly answered according to its metadata, and also, all descendant items are answered correctly, according to their metadata. If the name points to a ListItem then the ListItem evaluates to true (valid) if it is selected, and also, all descendant items are answered correctly according to their metadata. If the name points to an InjectedItem then the InjectedItem evaluates to true (valid) if all descendant items are answered correctly, according to their metadata. The number of true responses are added together. If they satisfy the minAnswered and maxAnswered attribute values, then this type returns true. Otherwise it returns false.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="title" type="xs:string"><xs:annotation><xs:documentation>The primary text to show on the form. Also known as "prompt" or "label" or "visibleText" or "caption"</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute default="true" name="enabled" type="xs:boolean"><xs:annotation><xs:documentation>Determines whether the user can interact with the displayed item when the form is first displayed.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute default="true" name="visible" type="xs:boolean"><xs:annotation><xs:documentation>Determines whether the item should be visible on a computer screen when the form is first displayed.</xs:documentation></xs:annotation></xs:attribute>
If this attribute is set to "true" (the default), then the form implementation must make this item available for use on the form. If this attribute is set to "false" on a parent or ancestor item, then all child/descendant items inherit this "false" setting, even if they have this attribute set to "true." In other words, the child/descendent items do not need to be implemented if any parent/ancestor item has this attribute set to false.
<xs:attribute default="true" name="mustImplement" type="xs:boolean"><xs:annotation><xs:documentation>If this attribute is set to "true" (the default), then the form implementation must make this item available for use on the form. If this attribute is set to "false" on a parent or ancestor item, then all child/descendant items inherit this "false" setting, even if they have this attribute set to "true." In other words, the child/descendent items do not need to be implemented if any parent/ancestor item has this attribute set to false.</xs:documentation></xs:annotation></xs:attribute>
CHANGED to T/F/OptionalIf @showInReport on a Question is false, then the Question and its ListItems (if any) should not be present in a typical report derived from this template. If this attribute appears on a ListItem, then the entire question and all ListItems should be omitted from the report. If this attribute appears on a Section, then the entire Section and all Section contents (descendents) should be omitted from the report. If @showInReport appears on a DisplayedItem, then the DisplayedItem (and all sub-items) should be omitted from the report.This attribute is usually set to false when a Question is used to control form behavior (e.g., skip logic), or when the Question provides unhelpful "negative" information about actions that did not occur or were not performed, or things that were not observed.
<xs:attribute default="True" name="showInReport"><xs:annotation><xs:documentation>CHANGED to T/F/Optional If @showInReport on a Question is false, then the Question and its ListItems (if any) should not be present in a typical report derived from this template. If this attribute appears on a ListItem, then the entire question and all ListItems should be omitted from the report. If this attribute appears on a Section, then the entire Section and all Section contents (descendents) should be omitted from the report. If @showInReport appears on a DisplayedItem, then the DisplayedItem (and all sub-items) should be omitted from the report. This attribute is usually set to false when a Question is used to control form behavior (e.g., skip logic), or when the Question provides unhelpful "negative" information about actions that did not occur or were not performed, or things that were not observed.</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:string"><xs:enumeration value="True"/><xs:enumeration value="False"/><xs:enumeration value="Optional"/></xs:restriction></xs:simpleType></xs:attribute>
@minCard is the minimum number of repetitions allowed for a section or question. The default value is 1, indicating that the user must answer any question(s) that has this attribute set. If @minCard is set to 0, then the item and all descendent questions are optional to answer.
<xs:attribute name="minCard" type="xs:unsignedShort" default="1"><xs:annotation><xs:documentation>@minCard is the minimum number of repetitions allowed for a section or question. The default value is 1, indicating that the user must answer any question(s) that has this attribute set. If @minCard is set to 0, then the item and all descendent questions are optional to answer.</xs:documentation></xs:annotation></xs:attribute>
@maxCard is the maximum number of repetitions allowed for a section or question. The default value is 1, indicating that the section or question cannot be repeated on the data entry form. A value of 0 indicates that the number of repeats is unlimited. If @maxCard is not 0, then Must be greater than or equal to minCard.
<xs:attribute name="maxCard" default="1" type="xs:unsignedShort"><xs:annotation><xs:documentation>@maxCard is the maximum number of repetitions allowed for a section or question. The default value is 1, indicating that the section or question cannot be repeated on the data entry form. A value of 0 indicates that the number of repeats is unlimited. If @maxCard is not 0, then Must be greater than or equal to minCard.</xs:documentation></xs:annotation></xs:attribute>
A globally unique string assigned to a repeating Question or Section, Injected Form, or any selected answer ListItem. This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among sections or questions, including those that are allowed to repeat and nest deeply.
<xs:attribute name="instanceGUID" type="xs:string"><xs:annotation><xs:documentation>A globally unique string assigned to a repeating Question or Section, Injected Form, or any selected answer ListItem. This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among sections or questions, including those that are allowed to repeat and nest deeply.</xs:documentation></xs:annotation></xs:attribute>
A globally unique string assigned from a Section, Question, ListItem or InjectedForm to the ID of its parent node (S, Q, LI or IF). This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among the above objects, including those that are allowed to repeat and nest deeply.
<xs:attribute name="parentGUID" type="xs:string"><xs:annotation><xs:documentation>A globally unique string assigned from a Section, Question, ListItem or InjectedForm to the ID of its parent node (S, Q, LI or IF). This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among the above objects, including those that are allowed to repeat and nest deeply.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute default="true" name="ordered" type="xs:boolean"><xs:annotation><xs:documentation>If false, then the form implementation may change the order of items in the section.</xs:documentation></xs:annotation></xs:attribute>
Allows the form filler to specify whether the current response is the initial response, or records the type of change made since the initial response was reported.
<xs:attribute name="responseTypeEnum"><xs:annotation><xs:documentation>Allows the form filler to specify whether the current response is the initial response, or records the type of change made since the initial response was reported.</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:string"><xs:enumeration value="initial"/><xs:enumeration value="correction"/><xs:enumeration value="update"/><xs:enumeration value="addition"/><xs:enumeration value="deletion"/><xs:enumeration value="multiple_changes"/></xs:restriction></xs:simpleType></xs:attribute>
<xs:attribute name="responseStatusEnum"><xs:annotation><xs:documentation>Expresses the finality of the response, e.g., draft, pending, tentative, final and retracted.</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:string"><xs:enumeration value="draft"/><xs:enumeration value="pending"/><xs:enumeration value="preliminary"/><xs:enumeration value="final"/><xs:enumeration value="retracted"/></xs:restriction></xs:simpleType></xs:attribute>
<xs:attribute name="responseRequired" type="xs:boolean" default="false"><xs:annotation><xs:documentation>If @responseRequired is set to true, then the appropriate text or Blob must be entered in the data-entry field associated with this list item.</xs:documentation></xs:annotation></xs:attribute>
Represents the default value of the ListItem in the FormDesign template, or the user's response in selecting one or more ListItems. If @multiSelect='false' on ListField then only one item may be selected.
<xs:attribute default="false" name="selected" type="xs:boolean"><xs:annotation><xs:documentation>Represents the default value of the ListItem in the FormDesign template, or the user's response in selecting one or more ListItems. If @multiSelect='false' on ListField then only one item may be selected.</xs:documentation></xs:annotation></xs:attribute>
If set to true, then selecting this ListItem must deactivate all descendant parts of the form, and ignore any user-entered values in the deactivated part. Deselecting the ListItem should reactivate the descendant items in their state at the time the items were deactivated.If items are disabled, then any data stored in the disabled questions should be removed.
<xs:attribute default="false" name="selectionDisablesChildren" type="xs:boolean"><xs:annotation><xs:documentation>If set to true, then selecting this ListItem must deactivate all descendant parts of the form, and ignore any user-entered values in the deactivated part. Deselecting the ListItem should reactivate the descendant items in their state at the time the items were deactivated. If items are disabled, then any data stored in the disabled questions should be removed.</xs:documentation></xs:annotation></xs:attribute>
NEWSelecting the current ListItem will enable the named items in this attribute's content.Prefixing any named with a hyphen (-) will reverse the above behaviour (i.e., the named items will be disabled).Unselecting the ListItem will reverse this behaviour.Prefixing the name with a tilde (~) will supress this reversal behavior.
<xs:attribute name="selectionActivatesItems" type="xs:NMTOKENS"><xs:annotation><xs:documentation>NEW Selecting the current ListItem will enable the named items in this attribute's content. Prefixing any named with a hyphen (-) will reverse the above behaviour (i.e., the named items will be disabled). Unselecting the ListItem will reverse this behaviour. Prefixing the name with a tilde (~) will supress this reversal behavior.</xs:documentation></xs:annotation></xs:attribute>
NEWSelecting the current ListItem will select the named ListItems in this attribute's content.Prefixing any named with a hyphen (-) will reverse the above behaviour.Unselecting the ListItem will reverse this behaviour.Prefixing the name with a tilde (~) will suppress this reversal behavior.
<xs:attribute name="selectionSelectsListItems" type="xs:NMTOKENS"><xs:annotation><xs:documentation>NEW Selecting the current ListItem will select the named ListItems in this attribute's content. Prefixing any named with a hyphen (-) will reverse the above behaviour. Unselecting the ListItem will reverse this behaviour. Prefixing the name with a tilde (~) will suppress this reversal behavior.</xs:documentation></xs:annotation></xs:attribute>
If the ancestor ListField has @multiselect = 'true', then selecting this ListItem should de-select all other ListItem (sibling) nodes except the current one.
<xs:attribute default="false" name="selectionDeselectsSiblings" type="xs:boolean"><xs:annotation><xs:documentation>If the ancestor ListField has @multiselect = 'true', then selecting this ListItem should de-select all other ListItem (sibling) nodes except the current one.</xs:documentation></xs:annotation></xs:attribute>
NEW: If @omitWhenSelected is set to true, then the question and its response(s) should not be present in a typical report derived from this template. This attribute is usually set to true when the answer choice is used to control form behavior (e.g., skip logic), or when the question provides unhelpful "negative" information about actions that did not occur or were not performed, or things that were not observed or could not be assessed. If @omitWhenSelectedset is false (default) then the question and its response(s) should appear in the report. Added 11/29/15 to replace @reportAction
<xs:attribute default="false" name="omitWhenSelected" type="xs:boolean"><xs:annotation><xs:documentation>NEW: If @omitWhenSelected is set to true, then the question and its response(s) should not be present in a typical report derived from this template. This attribute is usually set to true when the answer choice is used to control form behavior (e.g., skip logic), or when the question provides unhelpful "negative" information about actions that did not occur or were not performed, or things that were not observed or could not be assessed. If @omitWhenSelectedset is false (default) then the question and its response(s) should appear in the report. Added 11/29/15 to replace @reportAction</xs:documentation></xs:annotation></xs:attribute>
A typed value (e.g., an integer) that is uniquely associated with a ListItem. An example is the integer 10 for a ListItem with title that reads "10 o'clock". Typically these values are set to be used in calculations or other algorithms. In general, they can be treated something like a user-entered response on a the ListItemResponseField of a selected ListItem.This field should not be used for terminologies or local codes. The CodedValue type should be used for these kinds of metadata. This field should also not be used other properties such as translations, usage, etc.The data type shoudl be specified in @AssociatedValueType
<xs:attribute name="associatedValue" type="xs:string"><xs:annotation><xs:documentation>A typed value (e.g., an integer) that is uniquely associated with a ListItem. An example is the integer 10 for a ListItem with title that reads "10 o'clock". Typically these values are set to be used in calculations or other algorithms. In general, they can be treated something like a user-entered response on a the ListItemResponseField of a selected ListItem. This field should not be used for terminologies or local codes. The CodedValue type should be used for these kinds of metadata. This field should also not be used other properties such as translations, usage, etc. The data type shoudl be specified in @AssociatedValueType</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="associatedValueType" type="DataTypeAll_StypeEnum"><xs:annotation><xs:documentation>The data type of @AssociatedValue. Default is string.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute default="|" name="colTextDelimiter"><xs:annotation><xs:documentation>Character in the DisplayText that separates the columns and rows in a single or multi-column list.</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:string"><xs:length value="1"/></xs:restriction></xs:simpleType></xs:attribute>
<xs:attribute default="1" name="numCols" type="xs:unsignedByte"><xs:annotation><xs:documentation>Number of columns in the list</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute default="1" name="storedCol" type="xs:unsignedByte"><xs:annotation><xs:documentation>Determines which column of the list is stored in a database. This list is one-based.</xs:documentation></xs:annotation></xs:attribute>
Minimum number of answer choices (list items) that must be selected by the user. Default value is 1.NEW: changed minimum value to 1.Removed: If set to 0, then this question need not be answered by the user.
<xs:attribute default="1" name="minSelections"><xs:annotation><xs:documentation>Minimum number of answer choices (list items) that must be selected by the user. Default value is 1. NEW: changed minimum value to 1. Removed: If set to 0, then this question need not be answered by the user.</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:unsignedShort"><xs:minInclusive value="1"/></xs:restriction></xs:simpleType></xs:attribute>
Maximum number of answer choices (list items) that can be selected by the user. Must be greater than or equal to minSelections, and no larger than the total number of list items. A value of 0 indicates no limit to the number of selected list items (answers). This effectively means that the question is multi-select. (Abbreviated as QM)A value of 1 (the default) indicates that the question list is single-select. (Abbreviated as QS)
<xs:attribute default="1" name="maxSelections" type="xs:unsignedShort"><xs:annotation><xs:documentation>Maximum number of answer choices (list items) that can be selected by the user. Must be greater than or equal to minSelections, and no larger than the total number of list items. A value of 0 indicates no limit to the number of selected list items (answers). This effectively means that the question is multi-select. (Abbreviated as QM) A value of 1 (the default) indicates that the question list is single-select. (Abbreviated as QS)</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute default="true" name="ordered" type="xs:boolean"><xs:annotation><xs:documentation>If false, then the form implementation may change the order of items in the list.</xs:documentation></xs:annotation></xs:attribute>
Data type enumeration derived from W3C XML Schema. This element is used only if the ListItems are all associated with coded values from a single coding system.
<xs:attribute name="defaultListItemDataType" type="DataTypeAll_StypeEnum"><xs:annotation><xs:documentation>Data type enumeration derived from W3C XML Schema. This element is used only if the ListItems are all associated with coded values from a single coding system.</xs:documentation></xs:annotation></xs:attribute>
If @readOnly is set to true, the this field may not be edited by the user, and any default values set by template should be considered part of the stored data set responses, and transmitted by the SubmitForm transaction.
<xs:attribute default="false" name="readOnly" type="xs:boolean"><xs:annotation><xs:documentation>If @readOnly is set to true, the this field may not be edited by the user, and any default values set by template should be considered part of the stored data set responses, and transmitted by the SubmitForm transaction.</xs:documentation></xs:annotation></xs:attribute>
(reversible); If onlyIf is true, then the stipulated Boolean actions, which are executed when the If conditions evaluate to true, are reversed when the conditions evaluate to false.If onlyIf="true", the target items assume the chosen attribute values (e.g., selected, activated) ONLY when the action condition(s) are satisfied. If the conditions are not satisfied, then all Boolean actions assume the opposite state (e.g., unselected, inactive).Manually changing the attributes on the target item (upon which the actions are executed) will not affect any attributes in the controlling items. It is possible to disable (enabled="false") the target item so that its attributes can only be be changed programmatically.The default value is "false" indicating that the the rule runs when the "If" condition is "true." The attached action will not reverse (be undone) when the "If" condition evaluates to "false."
<xs:attribute name="onlyIf" type="xs:boolean" default="false"><xs:annotation><xs:documentation>(reversible); If onlyIf is true, then the stipulated Boolean actions, which are executed when the If conditions evaluate to true, are reversed when the conditions evaluate to false. If onlyIf="true", the target items assume the chosen attribute values (e.g., selected, activated) ONLY when the action condition(s) are satisfied. If the conditions are not satisfied, then all Boolean actions assume the opposite state (e.g., unselected, inactive). Manually changing the attributes on the target item (upon which the actions are executed) will not affect any attributes in the controlling items. It is possible to disable (enabled="false") the target item so that its attributes can only be be changed programmatically. The default value is "false" indicating that the the rule runs when the "If" condition is "true." The attached action will not reverse (be undone) when the "If" condition evaluates to "false."</xs:documentation></xs:annotation></xs:attribute>
This list contains the @names of Identified Items that will be automatically activated or deactivated when the @selectedItemSet evaluates to true. If a @name is prefixed with a hyphen (-), then the item will be deactivated when @selectedItemSet evaluates to true. If @not = true, then the Boolean rule evaluation is negated, and thus the rule works in reverse.If @onlyIf is true, then the above rule is reversed when @selectedItemSet evaluates to false. In other words, named items will be deactivated, and hyphen-prefixed items will be activated when @selectedItemSet is false.
<xs:attribute name="targetNameActivationList" type="xs:NCName"><xs:annotation><xs:documentation>This list contains the @names of Identified Items that will be automatically activated or deactivated when the @selectedItemSet evaluates to true. If a @name is prefixed with a hyphen (-), then the item will be deactivated when @selectedItemSet evaluates to true. If @not = true, then the Boolean rule evaluation is negated, and thus the rule works in reverse. If @onlyIf is true, then the above rule is reversed when @selectedItemSet evaluates to false. In other words, named items will be deactivated, and hyphen-prefixed items will be activated when @selectedItemSet is false.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute default="true" name="setVisibility" type="toggleType"><xs:annotation><xs:documentation>Make target items visible when activated and vice versa. Default = false. All descendants are affected in the same way.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute default="true" name="setEnabled" type="toggleType"><xs:annotation><xs:documentation>Make target items enabled when activated and vice versa. Default = true. All descendants are affected in the same way.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute default="true" name="setExpanded" type="toggleType"><xs:annotation><xs:documentation>Expand target items when activated and collapse item when deactivated. Default = false. All descendants are affected in the same way.</xs:documentation></xs:annotation></xs:attribute>
Delete all user selections, responses and comments when the item is deactivated. Applies to all descendant items as well. User should be warned before deleting anything, with an option to preserve the responses in the disabled items. Disabled item responses should not be saved with the form data.
<xs:attribute default="false" name="removeResponsesWhenDeactivated" type="xs:boolean"><xs:annotation><xs:documentation>Delete all user selections, responses and comments when the item is deactivated. Applies to all descendant items as well. User should be warned before deleting anything, with an option to preserve the responses in the disabled items. Disabled item responses should not be saved with the form data.</xs:documentation></xs:annotation></xs:attribute>
This list contains the @names of ListItems that will be automatically selected or deselected when the @selectedItemSet evaluates to true. If a @name is prefixed with a hyphen (-), then the item will be deselected when @selectedItemSet evaluates to true. If @not = true, then the Boolean rule evaluation is negated, and thus the rule works in reverse.If @onlyIf is true, then the above rule is reversed when @selectedItemSet evaluates to false. In other words, named items will be deselected, and hyphen-prefixed items will be selected when @selectedItemSet is false.
<xs:attribute name="targetNameSelectList" type="xs:NCName"><xs:annotation><xs:documentation>This list contains the @names of ListItems that will be automatically selected or deselected when the @selectedItemSet evaluates to true. If a @name is prefixed with a hyphen (-), then the item will be deselected when @selectedItemSet evaluates to true. If @not = true, then the Boolean rule evaluation is negated, and thus the rule works in reverse. If @onlyIf is true, then the above rule is reversed when @selectedItemSet evaluates to false. In other words, named items will be deselected, and hyphen-prefixed items will be selected when @selectedItemSet is false.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="formTitle" type="xs:string"><xs:annotation><xs:documentation>NEW: human readable title for display when choosing forms. Added 4/27/16</xs:documentation></xs:annotation></xs:attribute>
NEW: filename to use when the current FormDesign instance is saved as a file. For forms containing responses, the filename may include the formInstanceVersionURI, but the naming convention may be use-case-specific.
<xs:attribute name="filename" type="xs:string"><xs:annotation><xs:documentation>NEW: filename to use when the current FormDesign instance is saved as a file. For forms containing responses, the filename may include the formInstanceVersionURI, but the naming convention may be use-case-specific.</xs:documentation></xs:annotation></xs:attribute>
NEW: URI used to identify the form that that this FormDesign is based upon. In most cases, this should be a standard form that is modified and/or extended by the current FormDesign. The current template reuses the basedOn IDs whenever the question/answer/semantic context is identical to the original.5/11/17: Relying on data element mapping may be a better and more flexible approach than @basedOnURI. In this way, forms could compare data elements to determine if they contain semantic matches, and this is supported better with a more robust code map section.
<xs:attribute name="basedOnURI" type="URI_Atype"><xs:annotation><xs:documentation>NEW: URI used to identify the form that that this FormDesign is based upon. In most cases, this should be a standard form that is modified and/or extended by the current FormDesign. The current template reuses the basedOn IDs whenever the question/answer/semantic context is identical to the original. 5/11/17: Relying on data element mapping may be a better and more flexible approach than @basedOnURI. In this way, forms could compare data elements to determine if they contain semantic matches, and this is supported better with a more robust code map section.</xs:documentation></xs:annotation></xs:attribute>
NEW: A text identifier that is used to group multiple versions of a single form. The lineage is constant for all versions of a single kind of form. When appended to @baseURI, it can be used to retrieve all versions of one particular form.
<xs:attribute name="lineage" type="xs:string" use="required"><xs:annotation><xs:documentation>NEW: A text identifier that is used to group multiple versions of a single form. The lineage is constant for all versions of a single kind of form. When appended to @baseURI, it can be used to retrieve all versions of one particular form.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="version" type="xs:string" use="required"><xs:annotation><xs:documentation>NEW: @version contains the version text for the current form. It is designed to be used in conjuction with @baseURI and @lineage.</xs:documentation></xs:annotation></xs:attribute>
NEW: The full URI that uniquely identifies the current form. It is created by concatenating @baseURI + lineage + version. Each of the componenets is separated by a single forward slash.
<xs:attribute name="fullURI" type="URI_Atype" use="required"><xs:annotation><xs:documentation>NEW: The full URI that uniquely identifies the current form. It is created by concatenating @baseURI + lineage + version. Each of the componenets is separated by a single forward slash.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="prevVersionURI" type="URI_Atype"><xs:annotation><xs:documentation>NEW: The full URI used to identify the form that is the immediate previous version of the current FormDesign</xs:documentation></xs:annotation></xs:attribute>
NEW: Unique URI used to identify a unique instance of a form. Used for tracking form responses across time and across multiple episodes of editing by end-users. This URI does not change for each edit session of a form instance.
<xs:attribute name="formInstanceURI" type="URI_Atype"><xs:annotation><xs:documentation>NEW: Unique URI used to identify a unique instance of a form. Used for tracking form responses across time and across multiple episodes of editing by end-users. This URI does not change for each edit session of a form instance.</xs:documentation></xs:annotation></xs:attribute>
NEW: Unique URI used to identify a unique instance of a form's saved responses. It is used for tracking form responses across time and across multiple episodes of editing by end-users. This URI must change for each edit/save session of a form instance. It may be e.g., a new GUID, or a repeat of the formInstanceID followed by a version number.
<xs:attribute name="formInstanceVersionURI" type="URI_Atype"><xs:annotation><xs:documentation>NEW: Unique URI used to identify a unique instance of a form's saved responses. It is used for tracking form responses across time and across multiple episodes of editing by end-users. This URI must change for each edit/save session of a form instance. It may be e.g., a new GUID, or a repeat of the formInstanceID followed by a version number.</xs:documentation></xs:annotation></xs:attribute>
NEW: Unique URI used to identify the immediate previous instance of a form containing responses. This is the @formInstanceVersionURI that represents the instance of the form that the user opened up before beginning a new cycle of edit/save. This attribute is used for tracking form responses across time and across multiple episodes of editing by end-users. This URI must change for each edit session of a form instance.
<xs:attribute name="formPreviousInstanceVersionURI" type="URI_Atype"><xs:annotation><xs:documentation>NEW: Unique URI used to identify the immediate previous instance of a form containing responses. This is the @formInstanceVersionURI that represents the instance of the form that the user opened up before beginning a new cycle of edit/save. This attribute is used for tracking form responses across time and across multiple episodes of editing by end-users. This URI must change for each edit session of a form instance.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="pkgID" type="URI_Atype"><xs:annotation><xs:documentation>This ID represents the Package that contains the form to be injected. The package may contain an empty form or a form containing responses.</xs:documentation></xs:annotation></xs:attribute>
NEW: Unique URI used to identify a unique instance of a package. Used for tracking form responses across time and across multiple episodes of editing by end-users. This URI does not change for each edit session of a package instance.
<xs:attribute name="pkgInstanceURI" type="URI_Atype"><xs:annotation><xs:documentation>NEW: Unique URI used to identify a unique instance of a package. Used for tracking form responses across time and across multiple episodes of editing by end-users. This URI does not change for each edit session of a package instance.</xs:documentation></xs:annotation></xs:attribute>
NEW: Unique URI used to identify a unique instance of a package's saved responses. It is used for tracking package responses across time and across multiple episodes of editing by end-users. This URI must change for each edit/save session of a package instance. It may be e.g., a new GUID, or a repeat of the pkgInstanceID followed by a version number.
<xs:attribute name="pkgInstanceVersionURI" type="URI_Atype"><xs:annotation><xs:documentation>NEW: Unique URI used to identify a unique instance of a package's saved responses. It is used for tracking package responses across time and across multiple episodes of editing by end-users. This URI must change for each edit/save session of a package instance. It may be e.g., a new GUID, or a repeat of the pkgInstanceID followed by a version number.</xs:documentation></xs:annotation></xs:attribute>
DRAFT: The baseURI of the package, whihc indicates the home source of the package. The formManagerURP + pkgBaseURI + pkgID are concatenated to retrieve an empty form. formManagerURP + pkgBaseURI + pkgInstanceVersionURI are concatenated to retrieve a specific version of a populated form. formManagerURP + pkgBaseURI + pkgInstanceURI are concatenated to retrieve the latest instance of a populated form.
<xs:attribute name="pkgBaseURI" type="URI_Atype"><xs:annotation><xs:documentation>DRAFT: The baseURI of the package, whihc indicates the home source of the package. The formManagerURP + pkgBaseURI + pkgID are concatenated to retrieve an empty form. formManagerURP + pkgBaseURI + pkgInstanceVersionURI are concatenated to retrieve a specific version of a populated form. formManagerURP + pkgBaseURI + pkgInstanceURI are concatenated to retrieve the latest instance of a populated form.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="pkgFullURI" type="URI_Atype"><xs:annotation><xs:documentation>DRAFT: The injected package is retrieved form formManagerURI + "/" + pkgFullURI</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="pkgManagerURI" type="URI_Atype"><xs:annotation><xs:documentation>The server from which the injected package will be retrieved.</xs:documentation></xs:annotation></xs:attribute>
The rootItemID is the ID of the form part that will be injected. If empty, then the entre form should be injected as the FormDesign element node. If not empty, it must point to a valid Section or Question.
<xs:attribute name="rootItemID" type="URI_Atype"><xs:annotation><xs:documentation>The rootItemID is the ID of the form part that will be injected. If empty, then the entre form should be injected as the FormDesign element node. If not empty, it must point to a valid Section or Question.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="X_injectionID" type="xs:string"><xs:annotation><xs:documentation>Unique ID (GUID) to distinguish multiple instances of the same injected node.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="targetNames" type="xs:NMTOKENS"><xs:annotation><xs:documentation>The names of the parent items that will have the form (or form section) injected as child node(s).</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="title" type="xs:string"><xs:annotation><xs:documentation>NEW: human readable title for display when choosing forms. Added 4/27/16</xs:documentation></xs:annotation></xs:attribute>
NEW: filename to use when the current DE instance is saved as a file. For DEs containing responses, the filename may include the deInstanceVersionURI, but the naming convention may be use-case-specific.
<xs:attribute name="filename" type="xs:string"><xs:annotation><xs:documentation>NEW: filename to use when the current DE instance is saved as a file. For DEs containing responses, the filename may include the deInstanceVersionURI, but the naming convention may be use-case-specific.</xs:documentation></xs:annotation></xs:attribute>
NEW: URI used to identify the DE that that this DE is based upon. In most cases, this should be a standard form that is modified and/or extended by the current DE. The current template reuses the basedOn IDs whenever the question/answer/semantic context is identical to the original.
<xs:attribute name="basedOnURI" type="URI_Atype"><xs:annotation><xs:documentation>NEW: URI used to identify the DE that that this DE is based upon. In most cases, this should be a standard form that is modified and/or extended by the current DE. The current template reuses the basedOn IDs whenever the question/answer/semantic context is identical to the original.</xs:documentation></xs:annotation></xs:attribute>
NEW: A text identifier that is used to group multiple versions of a single DE. The lineage is constant for all versions of a single kind of DE. When appended to @baseURI, it can be used to retrieve all versions of one particular DE.
<xs:attribute name="lineage" type="xs:string" use="required"><xs:annotation><xs:documentation>NEW: A text identifier that is used to group multiple versions of a single DE. The lineage is constant for all versions of a single kind of DE. When appended to @baseURI, it can be used to retrieve all versions of one particular DE.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="version" type="xs:string" use="required"><xs:annotation><xs:documentation>NEW: @version contains the version text for the current DE. It is designed to be used in conjuction with @baseURI and @lineage.</xs:documentation></xs:annotation></xs:attribute>
NEW: The full URI that uniquely identifies the current DE. It is created by concatenating @baseURI + lineage + version. Each of the componenets is separated by a single forward slash.
<xs:attribute name="fullURI" type="URI_Atype" use="required"><xs:annotation><xs:documentation>NEW: The full URI that uniquely identifies the current DE. It is created by concatenating @baseURI + lineage + version. Each of the componenets is separated by a single forward slash.</xs:documentation></xs:annotation></xs:attribute>
<xs:attribute name="prevVersionURI" type="URI_Atype"><xs:annotation><xs:documentation>NEW: The full URI used to identify the DE that is the immediate previous version of the current DE</xs:documentation></xs:annotation></xs:attribute>
NEW: Unique URI used to identify a unique instance of a DE. Used for tracking DE responses across time and across multiple episodes of editing by end-users. This URI does not change for each edit session of a DE instance.
<xs:attribute name="instanceURI" type="URI_Atype"><xs:annotation><xs:documentation>NEW: Unique URI used to identify a unique instance of a DE. Used for tracking DE responses across time and across multiple episodes of editing by end-users. This URI does not change for each edit session of a DE instance.</xs:documentation></xs:annotation></xs:attribute>
NEW: Unique URI used to identify a unique instance of a DE's saved responses. It is used for tracking DE responses across time and across multiple episodes of editing by end-users. This URI must change for each edit/save session of a DE instance. It may be e.g., a new GUID, or a repeat of the deInstanceID followed by a version number.
<xs:attribute name="instanceVersionURI" type="URI_Atype"><xs:annotation><xs:documentation>NEW: Unique URI used to identify a unique instance of a DE's saved responses. It is used for tracking DE responses across time and across multiple episodes of editing by end-users. This URI must change for each edit/save session of a DE instance. It may be e.g., a new GUID, or a repeat of the deInstanceID followed by a version number.</xs:documentation></xs:annotation></xs:attribute>
NEW: Unique URI used to identify the immediate previous instance of a de containing responses. This is the @deInstanceVersionURI that represents the instance of the form that the user opened up before beginning a new cycle of edit/save. This attribute is used for tracking de responses across time and across multiple episodes of editing by end-users. This URI must change for each edit session of a de instance.
<xs:attribute name="previousInstanceVersionURI" type="URI_Atype"><xs:annotation><xs:documentation>NEW: Unique URI used to identify the immediate previous instance of a de containing responses. This is the @deInstanceVersionURI that represents the instance of the form that the user opened up before beginning a new cycle of edit/save. This attribute is used for tracking de responses across time and across multiple episodes of editing by end-users. This URI must change for each edit session of a de instance.</xs:documentation></xs:annotation></xs:attribute>
<xs:group name="ChildElementsGroup"><xs:choice><xs:annotation><xs:documentation>DisplayedType choices</xs:documentation></xs:annotation><xs:element minOccurs="0" name="Section" type="SectionItemType"><xs:annotation><xs:documentation>A Section is a grouper for other types of objects.</xs:documentation></xs:annotation></xs:element><xs:element minOccurs="0" name="Question" type="QuestionItemType"><xs:annotation><xs:documentation>A Question may take 3 basic forms: QS: single-select answer response QM: multi-select - more than one answer may be selected QF: fill-in response; no answer choices are present for selection QS and QM are associated with a ListField of answer choices. The ListField may contain a List with ListItems (expicitly stated answer choices), or it may contain a LookupEndpoint field that populates the list from a web service. See @maxSelections on ListField for information on distinguishing QS from QM. QF is identified by the presence of a ResponseField child, which describes how the fill-in response should be recorded.</xs:documentation></xs:annotation></xs:element><xs:element minOccurs="0" name="DisplayedItem" type="DisplayedType"><xs:annotation><xs:documentation>The DisplayedItem contains title, Blob (Binary Large Object), and/or Link content, and may also include Contacts and CodedValues that relate to the Note/Blob/Link objects. DisplayedItems may be interspersed with other MainItems or ListItem nodes. The parent items may be Section, Question, and ListItem. However, DisplayedItems are not "attached" to any specific item Section, Question, or ListItem. Instead they are free-floating items that can appear anywhere on a form, such as between ListItem nodes.</xs:documentation></xs:annotation></xs:element><xs:element minOccurs="0" name="ButtonAction" type="ButtonItemType"><xs:annotation><xs:documentation>A Button is a visible area that can be selected ("clicked") to trigger event code to perform an action. It is ordinarily implemented with an image that looks like a rectangular button object, but a button can look like anything.</xs:documentation></xs:annotation></xs:element><xs:element minOccurs="0" name="InjectForm" type="InjectFormType"><xs:annotation><xs:documentation>InjectForm is a link to a form (or portion of a form) that is imported into the current form at specific sites.</xs:documentation></xs:annotation></xs:element></xs:choice></xs:group>
This list contains names of ListItems (answer choices) that are watched for being selected or unselected.If a ListItem appears in this list, then it evaluates to true when it is selected. If a ListItem is prefixed with a hyphen (-), then it evaluates to true when unselected. These Boolean values, derived from each named ListItem in the list, are ANDed together (by default) to produce a return value of true or false. The default Boolean operator (AND) may be changed using @boolOp. If @not = true, then the Boolean result is logically negated.Renamed from: ListItemSelections
Source
<xs:attributeGroup name="SelectionDependencyAttributes"><xs:attributeGroup ref="BoolAttributes"/><xs:attribute use="required" name="selectedItemSet" type="xs:NMTOKENS"><xs:annotation><xs:documentation>This list contains names of ListItems (answer choices) that are watched for being selected or unselected. If a ListItem appears in this list, then it evaluates to true when it is selected. If a ListItem is prefixed with a hyphen (-), then it evaluates to true when unselected. These Boolean values, derived from each named ListItem in the list, are ANDed together (by default) to produce a return value of true or false. The default Boolean operator (AND) may be changed using @boolOp. If @not = true, then the Boolean result is logically negated. Renamed from: ListItemSelections</xs:documentation></xs:annotation></xs:attribute></xs:attributeGroup>
Attribute Group ResponseReportingAttributes
Namespace
urn:ihe:qrph:sdc:2016
Annotations
Used to extend identified items (Section, Question, ListItem) for nested/repeating responses in reports and data transmissions.
A globally unique string assigned to a repeating Question or Section, Injected Form, or any selected answer ListItem. This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among sections or questions, including those that are allowed to repeat and nest deeply.
A globally unique string assigned from a Section, Question, ListItem or InjectedForm to the ID of its parent node (S, Q, LI or IF). This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among the above objects, including those that are allowed to repeat and nest deeply.
For repeating questions and sections, @repeat represents the repeat ordinality, starting with 1.
Source
<xs:attributeGroup name="ResponseReportingAttributes"><xs:annotation><xs:documentation>Used to extend identified items (Section, Question, ListItem) for nested/repeating responses in reports and data transmissions.</xs:documentation></xs:annotation><xs:attribute default="1" name="repeat" type="xs:positiveInteger"><xs:annotation><xs:documentation>For repeating questions and sections, @repeat represents the repeat ordinality, starting with 1.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="instanceGUID" type="xs:string"><xs:annotation><xs:documentation>A globally unique string assigned to a repeating Question or Section, Injected Form, or any selected answer ListItem. This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among sections or questions, including those that are allowed to repeat and nest deeply.</xs:documentation></xs:annotation></xs:attribute><xs:attribute name="parentGUID" type="xs:string"><xs:annotation><xs:documentation>A globally unique string assigned from a Section, Question, ListItem or InjectedForm to the ID of its parent node (S, Q, LI or IF). This attribute's value is assigned at the time that answers are entered into a form, to unambiguously identify a single instance among the above objects, including those that are allowed to repeat and nest deeply.</xs:documentation></xs:annotation></xs:attribute></xs:attributeGroup>
Allows the form filler to specify whether the current response is the initial response, or records the type of change made since the initial response was reported.
Source
<xs:attributeGroup name="ResponseAttributes"><xs:attribute name="responseTypeEnum"><xs:annotation><xs:documentation>Allows the form filler to specify whether the current response is the initial response, or records the type of change made since the initial response was reported.</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:string"><xs:enumeration value="initial"/><xs:enumeration value="correction"/><xs:enumeration value="update"/><xs:enumeration value="addition"/><xs:enumeration value="deletion"/><xs:enumeration value="multiple_changes"/></xs:restriction></xs:simpleType></xs:attribute><xs:attribute name="responseStatusEnum"><xs:annotation><xs:documentation>Expresses the finality of the response, e.g., draft, pending, tentative, final and retracted.</xs:documentation></xs:annotation><xs:simpleType><xs:restriction base="xs:string"><xs:enumeration value="draft"/><xs:enumeration value="pending"/><xs:enumeration value="preliminary"/><xs:enumeration value="final"/><xs:enumeration value="retracted"/></xs:restriction></xs:simpleType></xs:attribute></xs:attributeGroup>
(reversible); If onlyIf is true, then the stipulated Boolean actions, which are executed when the If conditions evaluate to true, are reversed when the conditions evaluate to false.If onlyIf="true", the target items assume the chosen attribute values (e.g., selected, activated) ONLY when the action condition(s) are satisfied. If the conditions are not satisfied, then all Boolean actions assume the opposite state (e.g., unselected, inactive).Manually changing the attributes on the target item (upon which the actions are executed) will not affect any attributes in the controlling items. It is possible to disable (enabled="false") the target item so that its attributes can only be be changed programmatically.The default value is "false" indicating that the the rule runs when the "If" condition is "true." The attached action will not reverse (be undone) when the "If" condition evaluates to "false."
Source
<xs:attributeGroup name="IfAttributes"><xs:attribute name="onlyIf" type="xs:boolean" default="false"><xs:annotation><xs:documentation>(reversible); If onlyIf is true, then the stipulated Boolean actions, which are executed when the If conditions evaluate to true, are reversed when the conditions evaluate to false. If onlyIf="true", the target items assume the chosen attribute values (e.g., selected, activated) ONLY when the action condition(s) are satisfied. If the conditions are not satisfied, then all Boolean actions assume the opposite state (e.g., unselected, inactive). Manually changing the attributes on the target item (upon which the actions are executed) will not affect any attributes in the controlling items. It is possible to disable (enabled="false") the target item so that its attributes can only be be changed programmatically. The default value is "false" indicating that the the rule runs when the "If" condition is "true." The attached action will not reverse (be undone) when the "If" condition evaluates to "false."</xs:documentation></xs:annotation></xs:attribute></xs:attributeGroup>